diff --git a/.gitignore b/.gitignore
index 8b5d4f2ef954..99146109642d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -282,3 +282,4 @@ samples/openapi3/client/petstore/go/privatekey.pem
## OCaml
samples/client/petstore/ocaml/_build/
+/samples/client/jetbrains/adyen/checkout71/http/client/Apis/http-client.private.env.json
diff --git a/bin/configs/jetbrains-http-client-adyen-checkout-new.yaml b/bin/configs/jetbrains-http-client-adyen-checkout-new.yaml
new file mode 100644
index 000000000000..6a535618ae46
--- /dev/null
+++ b/bin/configs/jetbrains-http-client-adyen-checkout-new.yaml
@@ -0,0 +1,6 @@
+generatorName: jetbrains-http-client
+outputDir: samples/client/jetbrains/adyen/adyen/http/client
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutService-v71.yaml
+templateDir: modules/openapi-generator/src/main/resources/jetbrains-http-client
+additionalProperties:
+ hideGenerationTimestamp: "true"
diff --git a/bin/configs/jetbrains-http-client-adyen-checkout-simple.yaml b/bin/configs/jetbrains-http-client-adyen-checkout-simple.yaml
new file mode 100644
index 000000000000..dcdcb2573b88
--- /dev/null
+++ b/bin/configs/jetbrains-http-client-adyen-checkout-simple.yaml
@@ -0,0 +1,6 @@
+generatorName: jetbrains-http-client
+outputDir: samples/client/jetbrains/adyen/checkoutbasic/http/client
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasic.yaml
+templateDir: modules/openapi-generator/src/main/resources/jetbrains-http-client
+additionalProperties:
+ hideGenerationTimestamp: "true"
diff --git a/bin/configs/jetbrains-http-client-dota-new.yaml b/bin/configs/jetbrains-http-client-dota-new.yaml
new file mode 100644
index 000000000000..8948fa831aa7
--- /dev/null
+++ b/bin/configs/jetbrains-http-client-dota-new.yaml
@@ -0,0 +1,6 @@
+generatorName: jetbrains-http-client
+outputDir: samples/client/opendota/jetbrains/http/client
+inputSpec: modules/openapi-generator/src/test/resources/3_0/opendota.json
+templateDir: modules/openapi-generator/src/main/resources/jetbrains-http-client
+additionalProperties:
+ hideGenerationTimestamp: "true"
diff --git a/bin/configs/jetbrains-http-client-github-new.yaml b/bin/configs/jetbrains-http-client-github-new.yaml
new file mode 100644
index 000000000000..75a2e49839c5
--- /dev/null
+++ b/bin/configs/jetbrains-http-client-github-new.yaml
@@ -0,0 +1,6 @@
+generatorName: jetbrains-http-client
+outputDir: samples/client/github/jetbrains/http/client
+inputSpec: modules/openapi-generator/src/test/resources/3_0/jetbrains/github.json
+templateDir: modules/openapi-generator/src/main/resources/jetbrains-http-client
+additionalProperties:
+ hideGenerationTimestamp: "true"
diff --git a/docs/generators/jetbrains-http-client.md b/docs/generators/jetbrains-http-client.md
index d20d39cc3b24..8f985dc3de47 100644
--- a/docs/generators/jetbrains-http-client.md
+++ b/docs/generators/jetbrains-http-client.md
@@ -18,14 +18,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
-|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
-|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|
- **false**
- The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
- **true**
- Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
|true|
-|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
-|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|- **false**
- No changes to the enum's are made, this is the default option.
- **true**
- With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
|false|
-|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|- **true**
- The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
- **false**
- The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
|true|
-|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
-|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
+|bodyVariables|whether to convert body placeholders (i.e. VAR_1) into variables (i.e. {{VAR_1}})| |null|
+|customHeaders|custom headers that can be set for each request. Can be used for unsupported features, for example auth methods like oauth.| |null|
## IMPORT MAPPING
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JetbrainsHttpClientClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JetbrainsHttpClientClientCodegen.java
index 2f522425d84c..3722014699fd 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JetbrainsHttpClientClientCodegen.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JetbrainsHttpClientClientCodegen.java
@@ -16,35 +16,57 @@
package org.openapitools.codegen.languages;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.collect.ImmutableMap;
import com.samskivert.mustache.Mustache;
import com.samskivert.mustache.Template;
+import io.swagger.v3.core.util.Json;
+import io.swagger.v3.oas.models.examples.Example;
import org.openapitools.codegen.*;
import java.io.File;
import java.io.IOException;
import java.io.Writer;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.function.Function;
-import java.util.function.Predicate;
-import java.util.stream.Collectors;
+import java.util.*;
import org.openapitools.codegen.meta.GeneratorMetadata;
import org.openapitools.codegen.meta.Stability;
-import org.openapitools.codegen.model.ApiInfoMap;
import org.openapitools.codegen.model.ModelMap;
import org.openapitools.codegen.model.OperationMap;
import org.openapitools.codegen.model.OperationsMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/*
+Note : This code has been MASSIVELY inspired by PostmanCollectionCodegen from @gcatanese.
+
+Hopefully one day we can merge the similar code, as both generators stabilize
+ */
public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements CodegenConfig {
+
+ private final Logger LOGGER = LoggerFactory.getLogger(JetbrainsHttpClientClientCodegen.class);
+
+ public static final String JSON_ESCAPE_NEW_LINE = "\n";
+ public static final String JSON_ESCAPE_DOUBLE_QUOTE = "\"";
+
+ public static final String REQUEST_PARAMETER_GENERATION_DEFAULT_VALUE = "Example";
+ protected String requestParameterGeneration = REQUEST_PARAMETER_GENERATION_DEFAULT_VALUE; // values: Example, Schema
+
+
public static final String PROJECT_NAME = "Jetbrains HTTP Client";
+ public static final String BODY_VARIABLES = "bodyVariables";
+
+ public List bodyVariables = new ArrayList<>();
+
+ public static final String CUSTOM_HEADERS = "customHeaders";
+
+ public List customHeaders = new ArrayList<>();
+
+
public CodegenType getTag() {
return CodegenType.CLIENT;
}
@@ -74,6 +96,26 @@ public JetbrainsHttpClientClientCodegen() {
embeddedTemplateDir = templateDir = "jetbrains-http-client";
apiPackage = "Apis";
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
+
+
+ cliOptions.clear();
+ cliOptions.add(CliOption.newString(BODY_VARIABLES, "whether to convert body placeholders (i.e. VAR_1) into variables (i.e. {{VAR_1}})"));
+ cliOptions.add(CliOption.newString(CUSTOM_HEADERS, "custom headers that can be set for each request. Can be used for unsupported features, for example auth methods like oauth."));
+ }
+
+ @Override
+ public void processOpts() {
+ super.processOpts();
+
+ var additionalProperties = additionalProperties();
+
+ if(additionalProperties.containsKey(BODY_VARIABLES)) {
+ bodyVariables = Arrays.asList(additionalProperties.get(BODY_VARIABLES).toString().split("-"));
+ }
+
+ if(additionalProperties.containsKey(CUSTOM_HEADERS)) {
+ customHeaders = Arrays.asList(additionalProperties.get(CUSTOM_HEADERS).toString().split("&"));
+ }
}
@Override
@@ -95,24 +137,261 @@ public void execute(Template.Fragment fragment, Writer writer) throws IOExceptio
}
@Override
- public Map postProcessSupportingFileData(Map bundle) {
+ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
+ OperationsMap results = super.postProcessOperationsWithModels(objs, allModels);
+
+ OperationMap ops = results.getOperations();
+ List opList = ops.getOperation();
- return bundle;
+ for(CodegenOperation codegenOperation : opList) {
+ List requests = getRequests(codegenOperation);
+
+ if(requests != null) {
+ codegenOperation.vendorExtensions.put("requests", requests);
+ //Adding to each operation for now, we may be smarter later on
+ codegenOperation.vendorExtensions.put("customHeaders", customHeaders);
+ }
+ }
+ return results;
}
- @Override
- public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
- return super.postProcessOperationsWithModels(objs, allModels);
+ List getRequests(CodegenOperation codegenOperation) {
+ List items = new ArrayList<>();
+
+ if(codegenOperation.getHasBodyParam()) {
+ // operation with bodyParam
+ if (requestParameterGeneration.equalsIgnoreCase("Schema")) {
+ // get from schema
+ items.add(new RequestItem(codegenOperation.summary, getJsonFromSchema(codegenOperation.bodyParam)));
+ } else {
+ // get from examples
+ if (codegenOperation.bodyParam.example != null) {
+ // find in bodyParam example
+ items.add(new RequestItem(codegenOperation.summary, formatJson(codegenOperation.bodyParam.example)));
+ } else if (codegenOperation.bodyParam.getContent().get("application/json") != null &&
+ codegenOperation.bodyParam.getContent().get("application/json").getExamples() != null) {
+ // find in components/examples
+ for (Map.Entry entry : codegenOperation.bodyParam.getContent().get("application/json").getExamples().entrySet()) {
+ String exampleRef = entry.getValue().get$ref();
+ if(exampleRef != null){
+ Example example = this.openAPI.getComponents().getExamples().get(extractExampleByName(exampleRef));
+ String exampleAsString = getJsonFromExample(example);
+ items.add(new RequestItem(example.getSummary(), exampleAsString));
+ }
+ }
+ } else if (codegenOperation.bodyParam.getSchema() != null) {
+ // find in schema example
+ String exampleAsString = (codegenOperation.bodyParam.getSchema().getExample());
+ items.add(new RequestItem(codegenOperation.summary, exampleAsString));
+ } else {
+ // example not found
+ // get from schema
+ items.add(new RequestItem(codegenOperation.summary, getJsonFromSchema(codegenOperation.bodyParam)));
+
+ }
+ }
+ } else {
+ // operation without bodyParam
+ items.add(new RequestItem(codegenOperation.summary, null));
+ }
+
+ // Handling custom variables now
+ return handleCustomVariablesInRequests(items);
+ }
+
+ private List handleCustomVariablesInRequests(List items) {
+ if(!bodyVariables.isEmpty()){
+ for(var item : items){
+ for(var customVariable: bodyVariables){
+ var body = item.getBody();
+ if(body != null){
+ body = body.replace(customVariable, "{{" + customVariable + "}}");
+ item.setBody(body);
+ }
+ }
+ }
+ }
+
+ return items;
}
+
@Override
public void postProcess() {
- System.out.println("################################################################################");
- System.out.println("# Thanks for using OpenAPI Generator. #");
- System.out.println("# Please consider donation to help us maintain this project \uD83D\uDE4F #");
- System.out.println("# https://opencollective.com/openapi_generator/donate #");
- System.out.println("# #");
- System.out.println("# This generator was written by Julien Lengrand-Lambert (https://github.com/jlengrand) #");
- System.out.println("################################################################################");
+ System.out.println("##########################################################################################");
+ System.out.println("# Thanks for using OpenAPI Generator. #");
+ System.out.println("# Please consider donation to help us maintain this project \uD83D\uDE4F #");
+ System.out.println("# https://opencollective.com/openapi_generator/donate #");
+ System.out.println("# #");
+ System.out.println("# This generator was written by Julien Lengrand-Lambert (https://github.com/jlengrand) #");
+ System.out.println("##########################################################################################");
+ }
+
+ public class RequestItem {
+
+ private String name;
+ private String body;
+
+ public RequestItem(String name, String body) {
+ this.name = name;
+ this.body = body;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public String getBody() {
+ return body;
+ }
+
+ public void setBody(String body) {
+ this.body = body;
+ }
+ }
+
+ /*
+ Helpers
+ */
+
+ public String getJsonFromSchema(CodegenParameter codegenParameter) {
+
+ String ret = "{" + JSON_ESCAPE_NEW_LINE + " ";
+
+ int numVars = codegenParameter.vars.size();
+ int counter = 1;
+
+ for (CodegenProperty codegenProperty : codegenParameter.vars) {
+ ret = ret + JSON_ESCAPE_DOUBLE_QUOTE + codegenProperty.baseName + JSON_ESCAPE_DOUBLE_QUOTE + ": " +
+ JSON_ESCAPE_DOUBLE_QUOTE + "<" + getType(codegenProperty) + ">" + JSON_ESCAPE_DOUBLE_QUOTE;
+
+ if(counter < numVars) {
+ // add comma unless last attribute
+ ret = ret + "," + JSON_ESCAPE_NEW_LINE + " ";
+ }
+ counter++;
+
+ }
+
+ ret = ret + JSON_ESCAPE_NEW_LINE + "}";
+
+ return ret;
+ }
+
+ public String getType(CodegenProperty codegenProperty) {
+ if(codegenProperty.isNumeric) {
+ return "number";
+ } else if(codegenProperty.isDate) {
+ return "date";
+ } else {
+ return "string";
+ }
+ }
+
+ public String formatJson(String json) {
+
+ ObjectMapper objectMapper = new ObjectMapper();
+
+ try {
+ // convert to JSON object and prettify
+ JsonNode actualObj = objectMapper.readTree(json);
+ json = Json.pretty(actualObj);
+
+ } catch (JsonProcessingException e) {
+ LOGGER.warn("Error formatting JSON", e);
+ json = "";
+ }
+
+ return json;
+ }
+
+ public String extractExampleByName(String ref) {
+ return ref.substring(ref.lastIndexOf("/") + 1);
+ }
+
+ public String getJsonFromExample(Example example) {
+ String ret = "";
+
+ if(example == null) {
+ return ret;
+ }
+
+ if(example.getValue() instanceof ObjectNode) {
+ ret = convertToJson((ObjectNode)example.getValue());
+ } else if(example.getValue() instanceof LinkedHashMap) {
+ ret = convertToJson((LinkedHashMap)example.getValue());
+ }
+
+ return ret;
}
+
+ public String convertToJson(ObjectNode objectNode) {
+ return formatJson(objectNode.toString());
+ }
+
+ public String convertToJson(LinkedHashMap linkedHashMap) {
+ String ret = "";
+
+ return traverseMap(linkedHashMap, ret);
+ }
+
+ private String traverseMap(LinkedHashMap linkedHashMap, String ret) {
+
+ ret = ret + "{" + JSON_ESCAPE_NEW_LINE + " ";
+
+ int numVars = linkedHashMap.entrySet().size();
+ int counter = 1;
+
+ for (Map.Entry mapElement : linkedHashMap.entrySet()) {
+ String key = mapElement.getKey();
+ Object value = mapElement.getValue();
+
+ if(value instanceof String) {
+ // unescape double quotes already escaped
+ value = ((String)value).replace("\\\"", "\"");
+
+ ret = ret + JSON_ESCAPE_DOUBLE_QUOTE + key + JSON_ESCAPE_DOUBLE_QUOTE + ": " +
+ JSON_ESCAPE_DOUBLE_QUOTE + value + JSON_ESCAPE_DOUBLE_QUOTE;
+ } else if (value instanceof Integer || value instanceof Boolean) {
+ ret = ret + JSON_ESCAPE_DOUBLE_QUOTE + key + JSON_ESCAPE_DOUBLE_QUOTE + ": " +
+ value;
+ } else if (value instanceof HashMap) {
+ String in = ret + JSON_ESCAPE_DOUBLE_QUOTE + key + JSON_ESCAPE_DOUBLE_QUOTE + ": ";
+ ret = traverseMap(((LinkedHashMap) value), in);
+ } else if (value instanceof List) {
+ // TODO : What if it's a list of objects? _urgh_
+ var items = ((List>) value);
+ StringBuilder jsonBuilder = new StringBuilder("[");
+
+ for (int i = 0; i < items.size(); i++) {
+ jsonBuilder.append(JSON_ESCAPE_DOUBLE_QUOTE).append(items.get(i)).append(JSON_ESCAPE_DOUBLE_QUOTE);
+ if (i < items.size() - 1) {jsonBuilder.append(",");}
+ }
+ jsonBuilder.append("]");
+
+ ret = ret + JSON_ESCAPE_DOUBLE_QUOTE + key + JSON_ESCAPE_DOUBLE_QUOTE + ": " + jsonBuilder ;
+ }
+ else {
+ LOGGER.warn("Value type unrecognised: " + value.getClass());
+ //WARNING: here we are undoing what is done in "add comma unless last attribute"
+ // This is meant to avoid dangling commas if we encounter an unknown type
+ ret = ret.substring(0, ret.length() - 3);
+ }
+
+ if(counter < numVars ) {
+ // add comma unless last attribute
+ ret = ret + "," + JSON_ESCAPE_NEW_LINE + " ";
+ }
+ counter++;
+ }
+
+ ret = ret + JSON_ESCAPE_NEW_LINE + "}";
+
+ return ret;
+ }
+
}
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java
index 41188a092f4a..10745a5fd205 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PostmanCollectionCodegen.java
@@ -162,7 +162,6 @@ public List fromServerVariables(Map {{API_KEY}}
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY={{cookieKey}}"&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file
diff --git a/modules/openapi-generator/src/main/resources/jetbrains-http-client/api.mustache b/modules/openapi-generator/src/main/resources/jetbrains-http-client/api.mustache
index 43b1c2416b69..56b48b17eb80 100644
--- a/modules/openapi-generator/src/main/resources/jetbrains-http-client/api.mustache
+++ b/modules/openapi-generator/src/main/resources/jetbrains-http-client/api.mustache
@@ -2,10 +2,36 @@
{{#operations}}
{{#operation}}
+{{#vendorExtensions.requests}}
### {{#summary}}{{summary}}{{/summary}}
-# @name {{operationId}}
-{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}
-{{#consumes}}Content-Type: {{{mediaType}}}
+## {{name}}
+{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}{{#authMethods}}{{#isKeyInQuery}}?{{keyParamName}}={{#lambda.doubleMustache}}{queryKey}{{/lambda.doubleMustache}}{{/isKeyInQuery}}{{/authMethods}}
+{{#consumes}}
+Content-Type: {{{mediaType}}}
{{/consumes}}
-{{/operation}}
-{{/operations}}
\ No newline at end of file
+{{#produces}}
+Accept: {{{mediaType}}}
+{{/produces}}
+{{#vendorExtensions.customHeaders}}
+{{{.}}}
+{{/vendorExtensions.customHeaders}}
+{{#authMethods}}
+ {{#isKeyInCookie}}
+Cookie: {{keyParamName}}={{#lambda.doubleMustache}}{cookieKey}{{/lambda.doubleMustache}}
+ {{/isKeyInCookie}}
+ {{#isKeyInHeader}}
+{{keyParamName}}: {{#lambda.doubleMustache}}{apiKey}{{/lambda.doubleMustache}}
+ {{/isKeyInHeader}}
+ {{#isBasicBasic}}
+Authorization: Basic: {{#lambda.doubleMustache}}{username-password}{{/lambda.doubleMustache}}
+ {{/isBasicBasic}}
+ {{#isBasicBearer}}
+Authorization: Bearer {{#lambda.doubleMustache}}{bearerToken}{{/lambda.doubleMustache}}
+ {{/isBasicBearer}}
+{{/authMethods}}
+{{#body}}
+
+{{{.}}}
+
+{{/body}}
+{{/vendorExtensions.requests}}{{/operation}}{{/operations}}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenModelTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenModelTest.java
deleted file mode 100644
index 417b61c26c14..000000000000
--- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenModelTest.java
+++ /dev/null
@@ -1,29 +0,0 @@
-package org.openapitools.codegen.jetbrains.http.client;
-
-import org.openapitools.codegen.*;
-import org.openapitools.codegen.languages.JetbrainsHttpClientClientCodegen;
-import io.swagger.models.*;
-import io.swagger.models.properties.*;
-
-import org.testng.Assert;
-import org.testng.annotations.Test;
-
-@SuppressWarnings("static-method")
-public class JetbrainsHttpClientClientCodegenModelTest {
-
- @Test(description = "convert a simple java model")
- public void simpleModelTest() {
- final Model model = new ModelImpl()
- .description("a sample model")
- .property("id", new LongProperty())
- .property("name", new StringProperty())
- .required("id")
- .required("name");
- final DefaultCodegen codegen = new JetbrainsHttpClientClientCodegen();
-
- // TODO: Complete this test.
-// Assert.fail("Not implemented.");
- }
-
-}
-
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenTest.java
index 006da2439c1c..6362f286dfd0 100644
--- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenTest.java
+++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenTest.java
@@ -1,19 +1,484 @@
package org.openapitools.codegen.jetbrains.http.client;
+import org.junit.Ignore;
+import org.junit.Test;
import org.openapitools.codegen.*;
+import org.openapitools.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.languages.JetbrainsHttpClientClientCodegen;
-import io.swagger.models.*;
-import io.swagger.parser.SwaggerParser;
-import org.testng.Assert;
-import org.testng.annotations.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
+import static org.openapitools.codegen.TestUtils.assertFileExists;
public class JetbrainsHttpClientClientCodegenTest {
- JetbrainsHttpClientClientCodegen codegen = new JetbrainsHttpClientClientCodegen();
+ @Test
+ public void testBasicGenerationYaml() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/Basic.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/BasicApi.http");
+ assertFileExists(path);
+ TestUtils.assertFileContains(path, "## BasicApi\n" +
+ "\n" +
+ "### Get User\n" +
+ "## Get User\n" +
+ "GET http://localhost:5001/users/{{userId}}\n" +
+ "Accept: application/json\n" +
+ "Accept: application/xml");
+ }
@Test
- public void shouldSucceed() throws Exception {
- // TODO: Complete this test.
-// Assert.fail("Not implemented.");
+ public void testBasicGenerationJson() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/BasicJson.json")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/BasicApi.http");
+ assertFileExists(path);
+ TestUtils.assertFileContains(path, "## BasicApi\n" +
+ "\n" +
+ "### Get User\n" +
+ "## Get User\n" +
+ "GET http://localhost:5000/v1/users/{{userId}}\n" +
+ "Accept: application/json\n" +
+ "Accept: application/xml");
+ }
+
+ @Test
+ public void testBasicGenerationVariables() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/BasicVariablesInExample.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/BasicApi.http");
+ assertFileExists(path);
+ TestUtils.assertFileContains(path, "## BasicApi\n" +
+ "\n" +
+ "### Patch User\n" +
+ "## Example patch user\n" +
+ "PATCH http://localhost:5001/users/{{userId}}\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Accept: application/xml\n" +
+ "\n" +
+ "{\n" +
+ " \"id\": 1,\n" +
+ " \"firstName\": \"MY_VAR_NAME\",\n" +
+ " \"lastName\": \"MY_VAR_LAST_NAME\",\n" +
+ " \"email\": \"alotta.rotta@gmail.com\",\n" +
+ " \"dateOfBirth\": \"1997-10-31\",\n" +
+ " \"emailVerified\": true,\n" +
+ " \"createDate\": \"RANDOM_VALUE\"\n" +
+ "}");
+ }
+
+ @Test
+ public void testBasicGenerationVariablesWithBodyVariables() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/BasicVariablesInExample.yaml")
+ .addAdditionalProperty(JetbrainsHttpClientClientCodegen.BODY_VARIABLES, "MY_VAR_NAME-MY_VAR_LAST_NAME")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/BasicApi.http");
+ assertFileExists(path);
+ TestUtils.assertFileContains(path, "## BasicApi\n" +
+ "\n" +
+ "### Patch User\n" +
+ "## Example patch user\n" +
+ "PATCH http://localhost:5001/users/{{userId}}\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Accept: application/xml\n" +
+ "\n" +
+ "{\n" +
+ " \"id\": 1,\n" +
+ " \"firstName\": \"{{MY_VAR_NAME}}\",\n" +
+ " \"lastName\": \"{{MY_VAR_LAST_NAME}}\",\n" +
+ " \"email\": \"alotta.rotta@gmail.com\",\n" +
+ " \"dateOfBirth\": \"1997-10-31\",\n" +
+ " \"emailVerified\": true,\n" +
+ " \"createDate\": \"RANDOM_VALUE\"\n" +
+ "}");
+ }
+
+ @Test
+ public void testBasicGenerationWithCustomHeaders() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasic.yaml")
+ .addAdditionalProperty(JetbrainsHttpClientClientCodegen.CUSTOM_HEADERS, "Cookie:X-API-KEY={{cookieKey}}&Accept-Encoding=gzip")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## GooglePay request\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Cookie:X-API-KEY={{cookieKey}}\n" +
+ "Accept-Encoding=gzip");
+ }
+
+ @Test
+ public void testBasicGenerationAuthBearer() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicBearer.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ // Checking first and last
+ TestUtils.assertFileContains(path, "## PaymentsApi\n" +
+ "\n" +
+ "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}\n" +
+ "Accept: application/json\n" +
+ "Authorization: Bearer {{bearerToken}}");
+
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## Example with a merchant account that doesn't exist\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Authorization: Bearer {{bearerToken}}");
+ }
+
+ @Test
+ public void testBasicGenerationAuthCookie() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicCookie.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ // Checking first and last
+ TestUtils.assertFileContains(path, "## PaymentsApi\n" +
+ "\n" +
+ "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}\n" +
+ "Accept: application/json\n" +
+ "Cookie: X-API-Key={{cookieKey}}");
+
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## Example with a merchant account that doesn't exist\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Cookie: X-API-Key={{cookieKey}}");
+ }
+
+ @Test
+ public void testBasicGenerationAuthQuery() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicQuery.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ // Checking first and last
+ TestUtils.assertFileContains(path, "## PaymentsApi\n" +
+ "\n" +
+ "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}?api_key={{queryKey}}");
+
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## Example with a merchant account that doesn't exist\n" +
+ "POST https://checkout-test.adyen.com/v71/payments?api_key={{queryKey}}\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "\n" +
+ "{\n" +
+ " \"paymentMethod\" : {\n" +
+ " \"name\" : \"googlepay\"\n" +
+ " },\n" +
+ " \"amount\" : {\n" +
+ " \"currency\" : \"EUR\",\n" +
+ " \"value\" : 1000\n" +
+ " },\n" +
+ " \"merchantAccount\" : \"INVALID MERCHANT ACCOUNT\",\n" +
+ " \"reference\" : \"YOUR_REFERENCE\",\n" +
+ " \"channel\" : \"Android\"\n" +
+ "}");
+ }
+
+ @Test
+ public void testBasicGenerationAuthBasic() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicBasic.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ TestUtils.assertFileContains(path, "## PaymentsApi\n" +
+ "\n" +
+ "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}\n" +
+ "Accept: application/json\n" +
+ "Authorization: Basic: {{username-password}}");
+ }
+
+ @Test
+ public void testBasicGenerationAuthHeader() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicHeader.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ TestUtils.assertFileContains(path, "## PaymentsApi\n" +
+ "\n" +
+ "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}\n" +
+ "Accept: application/json\n" +
+ "X-API-Key: {{apiKey}}");
+ }
+
+ @Test
+ public void testBasicGenerationManyAuths() throws IOException {
+
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicBearerCookieQueryHeaderBasicBearer.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ TestUtils.assertFileContains(path, "### Get payment method by id\n" +
+ "## Get payment method by id\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}?api_key={{queryKey}}\n" +
+ "Accept: application/json\n" +
+ "Authorization: Bearer {{bearerToken}}");
+
+ TestUtils.assertFileContains(path, "### Get payment methods\n" +
+ "## Get payment methods\n" +
+ "GET https://checkout-test.adyen.com/v71/paymentMethods\n" +
+ "Accept: application/json\n" +
+ "Authorization: Basic: {{username-password}}\n" +
+ "Authorization: Bearer {{bearerToken}}");
+
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## Example with a merchant account that doesn't exist\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "Cookie: X-API-Key={{cookieKey}}\n" +
+ "Authorization: Bearer {{bearerToken}}");
+ }
+
+ @Test
+ @Ignore // For some reason this test fails during Docker image generation. Investigate one day.
+ public void testBasicGenerationMultipleRequests() throws IOException {
+ // Checking that each request example is present in the output file
+ File output = Files.createTempDirectory("jetbrainstest_").toFile();
+ output.deleteOnExit();
+
+ final CodegenConfigurator configurator = new CodegenConfigurator()
+ .setGeneratorName("jetbrains-http-client")
+ .setInputSpec("src/test/resources/3_0/jetbrains/CheckoutBasicMultiplekeys.yaml")
+ .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+ final ClientOptInput clientOptInput = configurator.toClientOptInput();
+ DefaultGenerator generator = new DefaultGenerator();
+ List files = generator.opts(clientOptInput).generate();
+
+ files.forEach(File::deleteOnExit);
+
+ Path path = Paths.get(output + "/Apis/PaymentsApi.http");
+ assertFileExists(path);
+
+ // Checking first and last
+ TestUtils.assertFileContains(path, "### Make a payment\n" +
+ "## ApplePay request\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "\n" +
+ "{\n" +
+ " \"paymentMethod\" : {\n" +
+ " \"name\" : \"applepay\"\n" +
+ " },\n" +
+ " \"amount\" : {\n" +
+ " \"currency\" : \"EUR\",\n" +
+ " \"value\" : 1000\n" +
+ " },\n" +
+ " \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n" +
+ " \"reference\" : \"YOUR_REFERENCE\",\n" +
+ " \"channel\" : \"iOS\"\n" +
+ "}\n" +
+ "\n" +
+ "### Make a payment\n" +
+ "## GooglePay request\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "\n" +
+ "{\n" +
+ " \"paymentMethod\" : {\n" +
+ " \"name\" : \"googlepay\"\n" +
+ " },\n" +
+ " \"amount\" : {\n" +
+ " \"currency\" : \"EUR\",\n" +
+ " \"value\" : 1000\n" +
+ " },\n" +
+ " \"merchantAccount\" : \"YOUR_MERCHANT_ACCOUNT\",\n" +
+ " \"reference\" : \"YOUR_REFERENCE\",\n" +
+ " \"channel\" : \"Android\"\n" +
+ "}\n" +
+ "\n" +
+ "### Make a payment\n" +
+ "## Example with a merchant account that doesn't exist\n" +
+ "POST https://checkout-test.adyen.com/v71/payments\n" +
+ "Content-Type: application/json\n" +
+ "Accept: application/json\n" +
+ "\n" +
+ "{\n" +
+ " \"paymentMethod\" : {\n" +
+ " \"name\" : \"googlepay\"\n" +
+ " },\n" +
+ " \"amount\" : {\n" +
+ " \"currency\" : \"EUR\",\n" +
+ " \"value\" : 1000\n" +
+ " },\n" +
+ " \"merchantAccount\" : \"INVALID MERCHANT ACCOUNT\",\n" +
+ " \"reference\" : \"YOUR_REFERENCE\",\n" +
+ " \"channel\" : \"Android\"\n" +
+ "}");
}
}
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/Basic.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/Basic.yaml
new file mode 100644
index 000000000000..a0ae0366b40d
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/Basic.yaml
@@ -0,0 +1,109 @@
+openapi: 3.1.0
+info:
+ title: Basic
+ version: '1.0'
+ contact:
+ name: Beppe Catanese
+ url: 'https://github.com/gcatanese'
+ description: Sample API
+ license:
+ name: Apache 2.0
+ url: 'https://github.com/gcatanese'
+servers:
+ - url: 'http://localhost:5001'
+ description: dev server
+ - url: 'http://localhost:5001'
+ description: test server
+paths:
+ '/users/{userId}':
+ get:
+ summary: Get User
+ description: Get User Info by User ID
+ operationId: get-users-userId
+ tags:
+ - basic
+ parameters:
+ - description: Unique identifier of the user
+ name: userId
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: User Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ Get User Alice Smith (json):
+ value:
+ id: 142
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ application/xml:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ Get User Alice Smith (xml):
+ value:
+ id: 143
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ '404':
+ description: User Not Found
+components:
+ schemas:
+ User:
+ title: User
+ type: object
+ description: ''
+ x-examples:
+ Alice Smith:
+ id: 144
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ properties:
+ id:
+ type: integer
+ description: Unique identifier for the given user.
+ firstName:
+ type: string
+ lastName:
+ type: string
+ email:
+ type: string
+ format: email
+ dateOfBirth:
+ type: string
+ format: date
+ example: '1997-10-31'
+ emailVerified:
+ type: boolean
+ description: Set to true if the user's email has been verified.
+ createDate:
+ type: string
+ format: date
+ description: The date that the user was created.
+ required:
+ - id
+ - firstName
+ - lastName
+ - email
+ - emailVerified
+tags:
+ - name: basic
+ description: Basic tag
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicJson.json b/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicJson.json
new file mode 100644
index 000000000000..2a27f22aa2dc
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicJson.json
@@ -0,0 +1,171 @@
+{
+ "openapi" : "3.1.0",
+ "info" : {
+ "contact" : {
+ "name" : "Beppe Catanese",
+ "url" : "https://github.com/gcatanese"
+ },
+ "description" : "Sample API",
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "https://github.com/gcatanese"
+ },
+ "title" : "Basic",
+ "version" : "1.0"
+ },
+ "servers" : [ {
+ "description" : "dev server",
+ "url" : "http://localhost:{port}/{version}",
+ "variables": {
+ "version": {
+ "default": "v1",
+ "description": "version of the API"
+ },
+ "port": {
+ "enum": [
+ "5000",
+ "8080"
+ ],
+ "default": "5000"
+ }
+ }
+ }, {
+ "description" : "test server",
+ "url" : "http://localhost:{port}/{version}",
+ "variables": {
+ "version": {
+ "default": "v1",
+ "description": "version of the API"
+ },
+ "port": {
+ "enum": [
+ "5000",
+ "8080"
+ ],
+ "default": "5000"
+ }
+ }
+ } ],
+ "tags" : [ {
+ "description" : "Basic tag",
+ "name" : "basic"
+ } ],
+ "paths" : {
+ "/users/{userId}" : {
+ "get" : {
+ "description" : "Get User Info by User ID",
+ "operationId" : "get-users-userId",
+ "parameters" : [ {
+ "description" : "Unique identifier of the user",
+ "explode" : false,
+ "in" : "path",
+ "name" : "userId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ },
+ "style" : "simple"
+ } ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "Get User Alice Smith (json)" : {
+ "value" : {
+ "id" : 142,
+ "firstName" : "Alice",
+ "lastName" : "Smith",
+ "email" : "alice.smith@gmail.com",
+ "dateOfBirth" : "1997-10-31",
+ "emailVerified" : true,
+ "signUpDate" : "2019-08-24"
+ }
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ },
+ "application/xml" : {
+ "examples" : {
+ "Get User Alice Smith (xml)" : {
+ "value" : {
+ "id" : 143,
+ "firstName" : "Alice",
+ "lastName" : "Smith",
+ "email" : "alice.smith@gmail.com",
+ "dateOfBirth" : "1997-10-31",
+ "emailVerified" : true,
+ "signUpDate" : "2019-08-24"
+ }
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ },
+ "description" : "User Found"
+ },
+ "404" : {
+ "description" : "User Not Found"
+ }
+ },
+ "summary" : "Get User",
+ "tags" : [ "basic" ]
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "User" : {
+ "description" : "",
+ "properties" : {
+ "id" : {
+ "description" : "Unique identifier for the given user.",
+ "type" : "integer"
+ },
+ "firstName" : {
+ "type" : "string"
+ },
+ "lastName" : {
+ "type" : "string"
+ },
+ "email" : {
+ "format" : "email",
+ "type" : "string"
+ },
+ "dateOfBirth" : {
+ "example" : "1997-10-31",
+ "format" : "date",
+ "type" : "string"
+ },
+ "emailVerified" : {
+ "description" : "Set to true if the user's email has been verified.",
+ "type" : "boolean"
+ },
+ "createDate" : {
+ "description" : "The date that the user was created.",
+ "format" : "date",
+ "type" : "string"
+ }
+ },
+ "required" : [ "email", "emailVerified", "firstName", "id", "lastName" ],
+ "title" : "User",
+ "type" : "object",
+ "x-examples" : {
+ "Alice Smith" : {
+ "id" : 144,
+ "firstName" : "Alice",
+ "lastName" : "Smith",
+ "email" : "alice.smith@gmail.com",
+ "dateOfBirth" : "1997-10-31",
+ "emailVerified" : true,
+ "signUpDate" : "2019-08-24"
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicVariablesInExample.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicVariablesInExample.yaml
new file mode 100644
index 000000000000..2c354ebaad71
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/BasicVariablesInExample.yaml
@@ -0,0 +1,116 @@
+openapi: 3.1.0
+info:
+ title: BasicExample
+ version: '1.0'
+ description: Sample API
+ license:
+ name: Apache 2.0
+ url: 'https://github.com/gcatanese'
+servers:
+ - url: 'http://localhost:5001'
+ description: dev server
+ - url: 'http://localhost:5001'
+ description: test server
+paths:
+ '/users/{userId}':
+ patch:
+ summary: Patch User
+ description: Update User Info
+ operationId: patch-users-userId
+ tags:
+ - basic
+ parameters:
+ - description: Unique identifier of the user
+ name: userId
+ in: path
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ examples:
+ patch-user:
+ $ref: '#/components/examples/patch-user-example'
+ schema:
+ $ref: '#/components/schemas/User'
+ responses:
+ '200':
+ description: User Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ Get User Alice Smith (json):
+ value:
+ id: 142
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ application/xml:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ Get User Alice Smith (xml):
+ value:
+ id: 143
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ '404':
+ description: User Not Found
+components:
+ schemas:
+ User:
+ title: User
+ type: object
+ description: ''
+ properties:
+ id:
+ type: integer
+ description: Unique identifier for the given user.
+ firstName:
+ type: string
+ lastName:
+ type: string
+ email:
+ type: string
+ format: email
+ dateOfBirth:
+ type: string
+ format: date
+ emailVerified:
+ type: boolean
+ description: Set to true if the user's email has been verified.
+ createDate:
+ type: string
+ format: date
+ description: The date that the user was created.
+ required:
+ - id
+ - firstName
+ - lastName
+ - email
+ - emailVerified
+ examples:
+ patch-user-example:
+ summary: Example patch user
+ value:
+ id: 001
+ firstName: MY_VAR_NAME
+ lastName: MY_VAR_LAST_NAME
+ email: alotta.rotta@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ createDate: RANDOM_VALUE
+
+tags:
+ - name: basic
+ description: Basic tag
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasic.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasic.yaml
new file mode 100644
index 000000000000..04926d7faf2b
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasic.yaml
@@ -0,0 +1,252 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBasic.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBasic.yaml
new file mode 100644
index 000000000000..5c882e0727f1
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBasic.yaml
@@ -0,0 +1,262 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - BasicAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - BasicAuth: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - BasicAuth: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ BasicAuth:
+ scheme: basic
+ type: http
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearer.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearer.yaml
new file mode 100644
index 000000000000..076512811d89
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearer.yaml
@@ -0,0 +1,263 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - BearerAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - BearerAuth: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - BearerAuth: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ BearerAuth:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearerCookieQueryHeaderBasicBearer.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearerCookieQueryHeaderBasicBearer.yaml
new file mode 100644
index 000000000000..1d99a5f5653d
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicBearerCookieQueryHeaderBasicBearer.yaml
@@ -0,0 +1,281 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - BearerAuth: [ ]
+ - BasicAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - BearerAuth: [ ]
+ - ApiKeyAuthQuery: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - BearerAuth: [ ]
+ - ApiKeyAuthCookie: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ BearerAuth:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+ BasicAuth:
+ scheme: basic
+ type: http
+ ApiKeyAuthQuery:
+ in: query
+ name: api_key
+ type: apiKey
+ ApiKeyAuthHeader:
+ in: header
+ name: X-API-Key
+ type: apiKey
+ ApiKeyAuthCookie:
+ in: cookie
+ name: X-API-Key
+ type: apiKey
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicCookie.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicCookie.yaml
new file mode 100644
index 000000000000..4c5b449e281b
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicCookie.yaml
@@ -0,0 +1,263 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - ApiKeyAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - ApiKeyAuth: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - ApiKeyAuth: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ ApiKeyAuth:
+ in: cookie
+ name: X-API-Key
+ type: apiKey
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicGET.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicGET.yaml
new file mode 100644
index 000000000000..6dcbbf56a70c
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicGET.yaml
@@ -0,0 +1,194 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicHeader.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicHeader.yaml
new file mode 100644
index 000000000000..7b65b9e44045
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicHeader.yaml
@@ -0,0 +1,263 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - ApiKeyAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - ApiKeyAuth: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - ApiKeyAuth: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ ApiKeyAuth:
+ in: header
+ name: X-API-Key
+ type: apiKey
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleKeys.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleKeys.yaml
new file mode 100644
index 000000000000..24b34511dc91
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleKeys.yaml
@@ -0,0 +1,254 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleResponsesGet.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleResponsesGet.yaml
new file mode 100644
index 000000000000..fc7eaeaf8dcc
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicMultipleResponsesGet.yaml
@@ -0,0 +1,201 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-failure'
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ payment-response-failure:
+ summary: FAILURE Merchant account validation error
+ value:
+ code: 422 - 900
+ message: FAILURE Merchant account does not exist
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicQuery.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicQuery.yaml
new file mode 100644
index 000000000000..7548d8732f02
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutBasicQuery.yaml
@@ -0,0 +1,263 @@
+openapi: 3.0.3
+info:
+ title: Checkout Basic
+ description: Checkout Basic
+ version: 1.0.0
+servers:
+ - url: 'https://checkout-test.adyen.com/v71'
+paths:
+
+ /paymentMethods:
+ get:
+ tags:
+ - Payments
+ summary: Get payment methods
+ operationId: get-payment-methods
+ security:
+ - ApiKeyAuth: [ ]
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/list-payment-methods'
+
+ /paymentMethods/{id}:
+ get:
+ tags:
+ - Payments
+ summary: Get payment method by id
+ operationId: get-payment-method-by-id
+ security:
+ - ApiKeyAuth: [ ]
+ parameters:
+ - description: Id of the payment method
+ name: id
+ in: path
+ required: true
+ schema:
+ type: string
+ examples:
+ basic:
+ value: googlepay
+ get-applepay:
+ value: applepay
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentMethod'
+ examples:
+ basic:
+ $ref: '#/components/examples/googlepay-payment-method'
+ get-applepay:
+ $ref: '#/components/examples/applepay-payment-method'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ basic:
+ $ref: '#/components/examples/merchant-account-validation-error'
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Make a payment
+ operationId: post-make-payment
+ security:
+ - ApiKeyAuth: [ ]
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Payment'
+ examples:
+ basic:
+ $ref: '#/components/examples/applepay-request'
+ googlepay-success:
+ $ref: '#/components/examples/googlepay-request'
+ invalid-merchant-account:
+ $ref: '#/components/examples/invalid-merchant-account'
+ responses:
+ 200:
+ description: OK - the request has succeeded.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PaymentResult'
+ examples:
+ basic:
+ $ref: '#/components/examples/payment-response-success'
+ googlepay-success:
+ $ref: '#/components/examples/payment-response-success'
+ 422:
+ description: Unprocessable Entity - a request validation error.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckoutError'
+ examples:
+ invalid-merchant-account:
+ $ref: '#/components/examples/merchant-account-validation-error'
+
+components:
+ securitySchemes:
+ ApiKeyAuth:
+ in: query
+ name: api_key
+ type: apiKey
+ schemas:
+ Payment:
+ type: object
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/PaymentMethod'
+ amount:
+ $ref: '#/components/schemas/Amount'
+ merchantAccount:
+ type: string
+ reference:
+ type: string
+ channel:
+ type: string
+ enum:
+ - Web
+ - iOS
+ - Android
+ required:
+ - paymentMethod
+ - amount
+ - merchantAccount
+ PaymentMethod:
+ type: object
+ properties:
+ name:
+ description: Name of the payment method
+ type: string
+ enum:
+ - scheme
+ - applepay
+ - googleplay
+ type:
+ description: Type of the payment method
+ type: string
+ Amount:
+ type: object
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ PaymentResult:
+ type: object
+ properties:
+ pspReference:
+ description: PSP ref
+ type: string
+ resultCode:
+ description: Result code
+ type: string
+ enum:
+ - success
+ - error
+ - pending
+ required:
+ - pspReference
+ - resultCode
+ CheckoutError:
+ type: object
+ properties:
+ code:
+ description: Error code
+ type: string
+ message:
+ description: User-friendly message
+ type: string
+ required:
+ - code
+ - message
+ examples:
+ applepay-request:
+ summary: ApplePay request
+ value:
+ paymentMethod:
+ name: applepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: iOS
+ googlepay-request:
+ summary: GooglePay request
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ invalid-merchant-account:
+ summary: Example with a merchant account that doesn't exist
+ value:
+ paymentMethod:
+ name: googlepay
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: INVALID MERCHANT ACCOUNT
+ reference: YOUR_REFERENCE
+ channel: Android
+ payment-response-success:
+ summary: A successful payment response
+ value:
+ pspReference: PSP1234567890
+ resultCode: success
+ generic-error-400:
+ summary: An error sample
+ value:
+ code: 400
+ message: Invalid JSON payload
+ merchant-account-validation-error:
+ summary: Merchant account validation error
+ value:
+ code: 422 - 900
+ message: Merchant account does not exist
+ googlepay-payment-method:
+ summary: The GooglePay payment method
+ value:
+ name: googlepay
+ type: wallet
+ applepay-payment-method:
+ summary: The ApplePay payment method
+ value:
+ name: applepay
+ type: wallet
+ list-payment-methods:
+ summary: List of all payment methods
+ value:
+ - name: googlepay
+ type: wallet
+ - name: applepay
+ type: wallet
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutService-v71.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutService-v71.yaml
new file mode 100644
index 000000000000..4377a5707dc9
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/CheckoutService-v71.yaml
@@ -0,0 +1,16216 @@
+openapi: 3.1.0
+servers:
+ - url: https://checkout-test.adyen.com/v71
+info:
+ version: '71'
+ x-publicVersion: true
+ title: Adyen Checkout API
+ description: 'Adyen Checkout API provides a simple and flexible way to initiate
+ and authorise online payments. You can use the same integration for payments made
+ with cards (including 3D Secure), mobile wallets, and local payment methods (for
+ example, iDEAL and Sofort).
+
+
+ This API reference provides information on available endpoints and how to interact
+ with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).
+
+
+ ## Authentication
+
+ Each request to Checkout API must be signed with an API key. For this, [get your
+ API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key)
+ from your Customer Area, and set this key to the `X-API-Key` header value, for
+ example:
+
+
+ ```
+
+ curl
+
+ -H "Content-Type: application/json" \
+
+ -H "X-API-Key: YOUR_API_KEY" \
+
+ ...
+
+ ```
+
+ ## Versioning
+
+ Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning)
+ using a version suffix in the endpoint URL. This suffix has the following format:
+ "vXX", where XX is the version number.
+
+
+ For example:
+
+ ```
+
+ https://checkout-test.adyen.com/v71/payments
+
+ ```
+
+
+ ## Going live
+
+
+ To access the live endpoints, you need an API key from your live Customer Area.
+
+
+ The live endpoint URLs contain a prefix which is unique to your company account,
+ for example:
+
+ ```
+
+ https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments
+
+ ```
+
+
+ Get your `{PREFIX}` from your live Customer Area under **Developers** > **API
+ URLs** > **Prefix**.
+
+
+ When preparing to do live transactions with Checkout API, follow the [go-live
+ checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure
+ you''ve got all the required configuration in place.
+
+
+ ## Release notes
+
+ Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=71)
+ to find out what changed in this version!'
+ termsOfService: https://www.adyen.com/legal/terms-and-conditions
+ contact:
+ name: Adyen Developer Experience team
+ url: https://github.com/Adyen/adyen-openapi
+tags:
+ - name: Payments
+ - name: Donations
+ - name: Payment links
+ - name: Modifications
+ - name: Recurring
+ - name: Orders
+ - name: Utility
+ - name: Classic Checkout SDK
+paths:
+ /applePay/sessions:
+ post:
+ tags:
+ - Utility
+ summary: Get an Apple Pay session
+ description: 'You need to use this endpoint if you have an API-only integration
+ with Apple Pay which uses Adyen''s Apple Pay certificate.
+
+
+ The endpoint returns the Apple Pay session data which you need to complete
+ the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).'
+ operationId: post-applePay-sessions
+ x-sortIndex: 2
+ x-methodName: getApplePaySession
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-applePay-sessions-basic'
+ schema:
+ $ref: '#/components/schemas/ApplePaySessionRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-applePay-sessions-basic-200'
+ schema:
+ $ref: '#/components/schemas/ApplePaySessionResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ /cancels:
+ post:
+ tags:
+ - Modifications
+ summary: Cancel an authorised payment
+ description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),
+ and returns a unique reference for this request. You get the outcome of the
+ request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).
+
+
+ If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference),
+ use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels)
+ endpoint instead.
+
+
+ If you want to cancel a payment but are not sure whether it has been captured,
+ use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)
+ endpoint instead.
+
+
+ For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).'
+ operationId: post-cancels
+ x-sortIndex: 3
+ x-methodName: cancelAuthorisedPayment
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ cancel-with-own-reference:
+ $ref: '#/components/examples/post-cancels-cancel-with-own-reference'
+ schema:
+ $ref: '#/components/schemas/StandalonePaymentCancelRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ cancel-with-own-reference:
+ $ref: '#/components/examples/post-cancels-cancel-with-own-reference-201'
+ schema:
+ $ref: '#/components/schemas/StandalonePaymentCancelResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /cardDetails:
+ post:
+ tags:
+ - Payments
+ summary: Get the list of brands on the card
+ description: 'Send a request with at least the first 6 digits of the card number
+ to get a response with an array of brands on the card. If you include [your
+ supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands)
+ in the request, the response also tells you if you support each [brand that
+ was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details).
+
+
+ If you have an API-only integration and collect card data, use this endpoint
+ to find out if the shopper''s card is co-branded. For co-branded cards, you
+ must let the shopper choose the brand to pay with if you support both brands.
+
+
+ '
+ operationId: post-cardDetails
+ x-sortIndex: 6
+ x-methodName: cardDetails
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-cardDetails-basic'
+ supported-brands:
+ $ref: '#/components/examples/post-cardDetails-supported-brands'
+ schema:
+ $ref: '#/components/schemas/CardDetailsRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-cardDetails-basic-200'
+ supported-brands:
+ $ref: '#/components/examples/post-cardDetails-supported-brands-200'
+ schema:
+ $ref: '#/components/schemas/CardDetailsResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ /donations:
+ post:
+ tags:
+ - Donations
+ summary: Start a transaction for donations
+ description: 'Takes in the donation token generated by the `/payments` request
+ and uses it to make the donation for the donation account specified in the
+ request.
+
+
+ For more information, see [Donations](https://docs.adyen.com/online-payments/donations).'
+ operationId: post-donations
+ x-sortIndex: 2
+ x-methodName: donations
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ donations:
+ $ref: '#/components/examples/post-donations-donations'
+ donations-with-token:
+ $ref: '#/components/examples/post-donations-donations-with-token'
+ schema:
+ $ref: '#/components/schemas/DonationPaymentRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ donations:
+ $ref: '#/components/examples/post-donations-donations-200'
+ schema:
+ $ref: '#/components/schemas/DonationPaymentResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /orders:
+ post:
+ tags:
+ - Orders
+ summary: Create an order
+ description: Creates an order to be used for partial payments. Make a POST `/orders`
+ call before making a `/payments` call when processing payments with different
+ payment methods.
+ operationId: post-orders
+ x-sortIndex: 2
+ x-methodName: orders
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-orders-basic'
+ schema:
+ $ref: '#/components/schemas/CreateOrderRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-orders-basic-200'
+ schema:
+ $ref: '#/components/schemas/CreateOrderResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /orders/cancel:
+ post:
+ tags:
+ - Orders
+ summary: Cancel an order
+ description: Cancels an order. Cancellation of an order results in an automatic
+ rollback of all payments made in the order, either by canceling or refunding
+ the payment, depending on the type of payment method.
+ operationId: post-orders-cancel
+ x-sortIndex: 3
+ x-methodName: cancelOrder
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-orders-cancel-basic'
+ schema:
+ $ref: '#/components/schemas/CancelOrderRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-orders-cancel-basic-200'
+ schema:
+ $ref: '#/components/schemas/CancelOrderResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /originKeys:
+ post:
+ tags:
+ - Utility
+ summary: Create originKey values for domains
+ description: "This operation takes the origin domains and returns a JSON object\
+ \ containing the corresponding origin keys for the domains. \n> If you're\
+ \ still using origin key for your Web Drop-in or Components integration, we\
+ \ recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key).\
+ \ This allows you to use a single key for all origins, add or remove origins\
+ \ without generating a new key, and detect the card type from the number entered\
+ \ in your payment form. "
+ deprecated: true
+ x-deprecatedInVersion: '67'
+ operationId: post-originKeys
+ x-sortIndex: 1
+ x-methodName: originKeys
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-originKeys-basic'
+ schema:
+ $ref: '#/components/schemas/UtilityRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-originKeys-basic-200'
+ schema:
+ $ref: '#/components/schemas/UtilityResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /paymentLinks:
+ post:
+ tags:
+ - Payment links
+ summary: Create a payment link
+ description: 'Creates a payment link to our hosted payment form where shoppers
+ can pay. The list of payment methods presented to the shopper depends on the
+ `currency` and `country` parameters sent in the request.
+
+
+ For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).'
+ operationId: post-paymentLinks
+ x-sortIndex: 1
+ x-methodName: paymentLinks
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentLinks-basic'
+ schema:
+ $ref: '#/components/schemas/PaymentLinkRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentLinks-basic-201'
+ schema:
+ $ref: '#/components/schemas/PaymentLinkResponse'
+ description: Created - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /paymentLinks/{linkId}:
+ get:
+ tags:
+ - Payment links
+ summary: Get a payment link
+ description: Retrieves the payment link details using the payment link `id`.
+ operationId: get-paymentLinks-linkId
+ x-sortIndex: 2
+ x-methodName: getPaymentLink
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ parameters:
+ - description: Unique identifier of the payment link.
+ name: linkId
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/get-paymentLinks-linkId-basic-200'
+ schema:
+ $ref: '#/components/schemas/PaymentLinkResponse'
+ description: OK - the request has succeeded.
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ patch:
+ tags:
+ - Payment links
+ summary: Update the status of a payment link
+ description: Updates the status of a payment link. Use this endpoint to [force
+ the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).
+ operationId: patch-paymentLinks-linkId
+ x-sortIndex: 3
+ x-methodName: updatePaymentLink
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/patch-paymentLinks-linkId-basic'
+ schema:
+ $ref: '#/components/schemas/UpdatePaymentLinkRequest'
+ parameters:
+ - description: Unique identifier of the payment link.
+ name: linkId
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200'
+ schema:
+ $ref: '#/components/schemas/PaymentLinkResponse'
+ description: OK - the request has succeeded.
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /paymentMethods:
+ post:
+ tags:
+ - Payments
+ summary: Get a list of available payment methods
+ description: 'Queries the available payment methods for a transaction based
+ on the transaction context (like amount, country, and currency). Besides giving
+ back a list of the available payment methods, the response also returns which
+ input details you need to collect from the shopper (to be submitted to `/payments`).
+
+
+ Although we highly recommend using this endpoint to ensure you are always
+ offering the most up-to-date list of payment methods, its usage is optional.
+ You can, for example, also cache the `/paymentMethods` response and update
+ it once a week.'
+ operationId: post-paymentMethods
+ x-sortIndex: 2
+ x-methodName: paymentMethods
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentMethods-basic'
+ filtered:
+ $ref: '#/components/examples/post-paymentMethods-filtered'
+ include-stored:
+ $ref: '#/components/examples/post-paymentMethods-include-stored'
+ schema:
+ $ref: '#/components/schemas/PaymentMethodsRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentMethods-basic-200'
+ filtered:
+ $ref: '#/components/examples/post-paymentMethods-filtered-200'
+ include-stored:
+ $ref: '#/components/examples/post-paymentMethods-include-stored-200'
+ schema:
+ $ref: '#/components/schemas/PaymentMethodsResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /paymentMethods/balance:
+ post:
+ tags:
+ - Orders
+ summary: Get the balance of a gift card
+ description: Retrieves the balance remaining on a shopper's gift card. To check
+ a gift card's balance, make a POST `/paymentMethods/balance` call and include
+ the gift card's details inside a `paymentMethod` object.
+ operationId: post-paymentMethods-balance
+ x-sortIndex: 1
+ x-methodName: getBalanceOfGiftCard
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentMethods-balance-basic'
+ not-enough:
+ $ref: '#/components/examples/post-paymentMethods-balance-not-enough'
+ schema:
+ $ref: '#/components/schemas/BalanceCheckRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-paymentMethods-balance-basic-200'
+ not-enough:
+ $ref: '#/components/examples/post-paymentMethods-balance-not-enough-200'
+ schema:
+ $ref: '#/components/schemas/BalanceCheckResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /paymentSession:
+ post:
+ tags:
+ - Classic Checkout SDK
+ summary: Create a payment session
+ description: 'Provides the data object that can be used to start the Checkout
+ SDK. To set up the payment, pass its amount, currency, and other required
+ parameters. We use this to optimise the payment flow and perform better risk
+ assessment of the transaction.
+
+
+ For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).'
+ deprecated: true
+ x-deprecatedInVersion: '37'
+ operationId: post-paymentSession
+ x-sortIndex: 1
+ x-methodName: paymentSession
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ android:
+ $ref: '#/components/examples/post-paymentSession-android'
+ enableOneClick:
+ $ref: '#/components/examples/post-paymentSession-enableOneClick'
+ ios:
+ $ref: '#/components/examples/post-paymentSession-ios'
+ split:
+ $ref: '#/components/examples/post-paymentSession-split'
+ web:
+ $ref: '#/components/examples/post-paymentSession-web'
+ schema:
+ $ref: '#/components/schemas/PaymentSetupRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ enableOneClick:
+ $ref: '#/components/examples/post-paymentSession-enableOneClick-200'
+ web:
+ $ref: '#/components/examples/post-paymentSession-web-200'
+ schema:
+ $ref: '#/components/schemas/PaymentSetupResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments:
+ post:
+ tags:
+ - Payments
+ summary: Start a transaction
+ description: "Sends payment parameters (like amount, country, and currency)\
+ \ together with other required input details collected from the shopper. To\
+ \ know more about required parameters for specific payment methods, refer\
+ \ to our [payment method guides](https://docs.adyen.com/payment-methods).\
+ \ \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n\
+ * For a direct flow, the response includes a `pspReference` and a `resultCode`\
+ \ with the payment result, for example **Authorised** or **Refused**. \n*\
+ \ For a redirect or additional action, the response contains an `action` object. "
+ operationId: post-payments
+ x-sortIndex: 3
+ x-methodName: payments
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ applepay:
+ $ref: '#/components/examples/post-payments-applepay'
+ card-3d-secure-2-web:
+ $ref: '#/components/examples/post-payments-card-3d-secure-2-web'
+ card-3d-secure-direct:
+ $ref: '#/components/examples/post-payments-card-3d-secure-direct'
+ card-direct:
+ $ref: '#/components/examples/post-payments-card-direct'
+ card-securedfields:
+ $ref: '#/components/examples/post-payments-card-securedfields'
+ enableOneClick-SF:
+ $ref: '#/components/examples/post-payments-enableOneClick-SF'
+ googlepay:
+ $ref: '#/components/examples/post-payments-googlepay'
+ ideal:
+ $ref: '#/components/examples/post-payments-ideal'
+ klarna:
+ $ref: '#/components/examples/post-payments-klarna'
+ oneclick-securedfields:
+ $ref: '#/components/examples/post-payments-oneclick-securedfields'
+ recurring:
+ $ref: '#/components/examples/post-payments-recurring'
+ split-balanceplatform:
+ $ref: '#/components/examples/post-payments-split-balanceplatform'
+ split-classic:
+ $ref: '#/components/examples/post-payments-split-classic'
+ subscription-first-transaction:
+ $ref: '#/components/examples/post-payments-subscription-first-transaction'
+ schema:
+ $ref: '#/components/schemas/PaymentRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ card-direct:
+ $ref: '#/components/examples/post-payments-card-direct-200'
+ card-securedfields:
+ $ref: '#/components/examples/post-payments-card-securedfields-200'
+ enableOneClick-SF:
+ $ref: '#/components/examples/post-payments-enableOneClick-SF-200'
+ ideal:
+ $ref: '#/components/examples/post-payments-ideal-200'
+ split-balanceplatform:
+ $ref: '#/components/examples/post-payments-split-balanceplatform-200'
+ subscription-first-transaction:
+ $ref: '#/components/examples/post-payments-subscription-first-transaction-200'
+ schema:
+ $ref: '#/components/schemas/PaymentResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/details:
+ post:
+ tags:
+ - Payments
+ summary: Submit details for a payment
+ description: 'Submits details for a payment created using `/payments`. This
+ step is only needed when no final state has been reached on the `/payments`
+ request, for example when the shopper was redirected to another page to complete
+ the payment.
+
+
+ '
+ operationId: post-payments-details
+ x-sortIndex: 4
+ x-methodName: paymentsDetails
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ 00.redirect:
+ $ref: '#/components/examples/post-payments-details-00.redirect'
+ 3d-secure-2-native:
+ $ref: '#/components/examples/post-payments-details-3d-secure-2-native'
+ schema:
+ $ref: '#/components/schemas/PaymentDetailsRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ 00.redirect:
+ $ref: '#/components/examples/post-payments-details-00.redirect-200'
+ schema:
+ $ref: '#/components/schemas/PaymentDetailsResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/result:
+ post:
+ tags:
+ - Classic Checkout SDK
+ summary: Verify a payment result
+ description: 'Verifies the payment result using the payload returned from the
+ Checkout SDK.
+
+
+ For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).'
+ deprecated: true
+ x-deprecatedInVersion: '37'
+ operationId: post-payments-result
+ x-sortIndex: 2
+ x-methodName: verifyPaymentResult
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-payments-result-basic'
+ schema:
+ $ref: '#/components/schemas/PaymentVerificationRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ basic:
+ $ref: '#/components/examples/post-payments-result-basic-200'
+ schema:
+ $ref: '#/components/schemas/PaymentVerificationResponse'
+ description: OK - the request has succeeded.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/{paymentPspReference}/amountUpdates:
+ post:
+ tags:
+ - Modifications
+ summary: Update an authorised amount
+ description: 'Increases or decreases the authorised payment amount and returns
+ a unique reference for this request. You get the outcome of the request asynchronously,
+ in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).
+
+
+ You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).
+
+
+ The amount you specify in the request is the updated amount, which is larger
+ or smaller than the initial authorised amount.
+
+
+ For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).'
+ operationId: post-payments-paymentPspReference-amountUpdates
+ x-sortIndex: 6
+ x-methodName: updateAuthorisedAmount
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ amount-update:
+ $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update'
+ schema:
+ $ref: '#/components/schemas/PaymentAmountUpdateRequest'
+ parameters:
+ - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment.
+ name: paymentPspReference
+ in: path
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ amount-update:
+ $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update-201'
+ schema:
+ $ref: '#/components/schemas/PaymentAmountUpdateResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/{paymentPspReference}/cancels:
+ post:
+ tags:
+ - Modifications
+ summary: Cancel an authorised payment
+ description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures),
+ and returns a unique reference for this request. You get the outcome of the
+ request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).
+
+
+ If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference),
+ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels)
+ endpoint instead.
+
+
+ If you want to cancel a payment but are not sure whether it has been captured,
+ use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)
+ endpoint instead.
+
+
+ For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).'
+ operationId: post-payments-paymentPspReference-cancels
+ x-sortIndex: 2
+ x-methodName: cancelAuthorisedPaymentByPspReference
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ cancel-with-psp-reference:
+ $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference'
+ schema:
+ $ref: '#/components/schemas/PaymentCancelRequest'
+ parameters:
+ - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment that you want to cancel. '
+ name: paymentPspReference
+ in: path
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ cancel-with-psp-reference:
+ $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201'
+ schema:
+ $ref: '#/components/schemas/PaymentCancelResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/{paymentPspReference}/captures:
+ post:
+ tags:
+ - Modifications
+ summary: Capture an authorised payment
+ description: " Captures an authorised payment and returns a unique reference\
+ \ for this request. You get the outcome of the request asynchronously, in\
+ \ a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\
+ \nYou can capture either the full authorised amount or a part of the authorised\
+ \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\
+ \ This does not apply if you enabled multiple partial captures on your account\
+ \ and the payment method supports multiple partial captures. \n\n[Automatic\
+ \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\
+ \ is the default setting for most payment methods. In these cases, you don't\
+ \ need to make capture requests. However, making capture requests for payments\
+ \ that are captured automatically does not result in double charges.\n\nFor\
+ \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
+ operationId: post-payments-paymentPspReference-captures
+ x-sortIndex: 1
+ x-methodName: captureAuthorisedPayment
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ capture:
+ $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture'
+ schema:
+ $ref: '#/components/schemas/PaymentCaptureRequest'
+ parameters:
+ - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment that you want to capture.
+ name: paymentPspReference
+ in: path
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ capture:
+ $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture-201'
+ schema:
+ $ref: '#/components/schemas/PaymentCaptureResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/{paymentPspReference}/refunds:
+ post:
+ tags:
+ - Modifications
+ summary: Refund a captured payment
+ description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\
+ \ and returns a unique reference for this request. You get the outcome of\
+ \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\
+ \nYou can refund either the full captured amount or a part of the captured\
+ \ amount. You can also perform multiple partial refunds, as long as their\
+ \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\
+ \ support partial refunds. To learn if a payment method supports partial refunds,\
+ \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\
+ \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\
+ \ \n\nIf you want to refund a payment but are not sure whether it has been\
+ \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\
+ \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)."
+ operationId: post-payments-paymentPspReference-refunds
+ x-sortIndex: 4
+ x-methodName: refundCapturedPayment
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ refund:
+ $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund'
+ schema:
+ $ref: '#/components/schemas/PaymentRefundRequest'
+ parameters:
+ - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment that you want to refund.
+ name: paymentPspReference
+ in: path
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ refund:
+ $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund-201'
+ schema:
+ $ref: '#/components/schemas/PaymentRefundResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /payments/{paymentPspReference}/reversals:
+ post:
+ tags:
+ - Modifications
+ summary: Refund or cancel a payment
+ description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds)
+ a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels)
+ a payment if it has not yet been captured. Returns a unique reference for
+ this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND**
+ webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).
+
+
+ The reversed amount is always the full payment amount.
+
+ > Do not use this request for payments that involve multiple partial captures.
+
+
+ For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).'
+ operationId: post-payments-paymentPspReference-reversals
+ x-sortIndex: 5
+ x-methodName: refundOrCancelPayment
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ reversal:
+ $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal'
+ schema:
+ $ref: '#/components/schemas/PaymentReversalRequest'
+ parameters:
+ - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment that you want to reverse. '
+ name: paymentPspReference
+ in: path
+ required: true
+ schema:
+ type: string
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ reversal:
+ $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal-201'
+ schema:
+ $ref: '#/components/schemas/PaymentReversalResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '400':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-400'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Bad Request - a problem reading or understanding the request.
+ '401':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-401'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unauthorized - authentication required.
+ '403':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-403'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Forbidden - insufficient permissions to process the request.
+ '422':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-422'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Unprocessable Entity - a request validation error.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ '500':
+ content:
+ application/json:
+ examples:
+ generic:
+ $ref: '#/components/examples/generic-500'
+ schema:
+ $ref: '#/components/schemas/ServiceError'
+ description: Internal Server Error - the server could not process the request.
+ /sessions:
+ post:
+ tags:
+ - Payments
+ summary: Create a payment session
+ description: 'Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in)
+ and [Web Components](https://docs.adyen.com/online-payments/web-components)
+ integrations.
+
+
+ The response contains encrypted payment session data. The front end then uses
+ the session data to make any required server-side calls for the payment flow.
+
+
+ You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION)
+ webhook.'
+ x-addedInVersion: '68'
+ operationId: post-sessions
+ x-sortIndex: 1
+ x-methodName: sessions
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ requestBody:
+ content:
+ application/json:
+ examples:
+ 00.success:
+ $ref: '#/components/examples/post-sessions-00.success'
+ 01.klarna:
+ $ref: '#/components/examples/post-sessions-01.klarna'
+ enableOneClick:
+ $ref: '#/components/examples/post-sessions-enableOneClick'
+ split:
+ $ref: '#/components/examples/post-sessions-split'
+ schema:
+ $ref: '#/components/schemas/CreateCheckoutSessionRequest'
+ parameters:
+ - $ref: '#/components/parameters/Idempotency-Key'
+ responses:
+ '201':
+ content:
+ application/json:
+ examples:
+ 00.success:
+ $ref: '#/components/examples/post-sessions-00.success-201'
+ 01.klarna:
+ $ref: '#/components/examples/post-sessions-01.klarna-201'
+ enableOneClick:
+ $ref: '#/components/examples/post-sessions-enableOneClick-201'
+ split:
+ $ref: '#/components/examples/post-sessions-split-201'
+ schema:
+ $ref: '#/components/schemas/CreateCheckoutSessionResponse'
+ description: Created - the request has been fulfilled and has resulted in
+ one or more new resources being created.
+ headers:
+ Idempotency-Key:
+ $ref: '#/components/headers/Idempotency-Key'
+ /sessions/{sessionId}:
+ get:
+ tags:
+ - Payments
+ summary: Get the result of a payment session
+ description: Returns the status of the payment session with the `sessionId`
+ and `sessionResult` specified in the path.
+ x-addedInVersion: '68'
+ operationId: get-sessions-sessionId
+ x-sortIndex: 2
+ x-methodName: getResultOfPaymentSession
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ parameters:
+ - description: A unique identifier of the session.
+ name: sessionId
+ in: path
+ required: true
+ schema:
+ type: string
+ - description: The `sessionResult` value from the Drop-in or Component.
+ name: sessionResult
+ in: query
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ success:
+ $ref: '#/components/examples/get-sessions-sessionId-success-200'
+ schema:
+ $ref: '#/components/schemas/SessionResultResponse'
+ description: OK - the request has succeeded.
+ /storedPaymentMethods:
+ get:
+ tags:
+ - Recurring
+ summary: Get tokens for stored payment details
+ description: 'Lists the tokens for stored payment details for the shopper identified
+ in the path, if there are any available. The token ID can be used with payment
+ requests for the shopper''s payment. A summary of the stored details is included.
+
+
+ '
+ x-addedInVersion: '70'
+ operationId: get-storedPaymentMethods
+ x-sortIndex: 2
+ x-methodName: getTokensForStoredPaymentDetails
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ parameters:
+ - description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information (PII),
+ for example name or email address.'
+ name: shopperReference
+ in: query
+ required: false
+ schema:
+ type: string
+ - description: Your merchant account.
+ name: merchantAccount
+ in: query
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ examples:
+ success:
+ $ref: '#/components/examples/get-storedPaymentMethods-success-200'
+ schema:
+ $ref: '#/components/schemas/ListStoredPaymentMethodsResponse'
+ description: OK - the request has succeeded.
+ /storedPaymentMethods/{storedPaymentMethodId}:
+ delete:
+ tags:
+ - Recurring
+ summary: Delete a token for stored payment details
+ description: Deletes the token identified in the path. The token can no longer
+ be used with payment requests.
+ x-addedInVersion: '70'
+ operationId: delete-storedPaymentMethods-storedPaymentMethodId
+ x-sortIndex: 4
+ x-methodName: deleteTokenForStoredPaymentDetails
+ security:
+ - BasicAuth: []
+ - ApiKeyAuth: []
+ parameters:
+ - description: The unique identifier of the token.
+ name: storedPaymentMethodId
+ in: path
+ required: true
+ schema:
+ type: string
+ - description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information (PII),
+ for example name or email address.'
+ name: shopperReference
+ in: query
+ required: true
+ schema:
+ type: string
+ - description: Your merchant account.
+ name: merchantAccount
+ in: query
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: 'No Content - look at the actual response code for the status
+ of the request. '
+components:
+ schemas:
+ AccountInfo:
+ properties:
+ accountAgeIndicator:
+ description: 'Indicator for the length of time since this shopper account
+ was created in the merchant''s environment.
+
+ Allowed values:
+
+ * notApplicable
+
+ * thisTransaction
+
+ * lessThan30Days
+
+ * from30To60Days
+
+ * moreThan60Days'
+ enum:
+ - notApplicable
+ - thisTransaction
+ - lessThan30Days
+ - from30To60Days
+ - moreThan60Days
+ type: string
+ accountChangeDate:
+ description: Date when the shopper's account was last changed.
+ format: date-time
+ type: string
+ accountChangeIndicator:
+ description: 'Indicator for the length of time since the shopper''s account
+ was last updated.
+
+ Allowed values:
+
+ * thisTransaction
+
+ * lessThan30Days
+
+ * from30To60Days
+
+ * moreThan60Days'
+ enum:
+ - thisTransaction
+ - lessThan30Days
+ - from30To60Days
+ - moreThan60Days
+ type: string
+ accountCreationDate:
+ description: Date when the shopper's account was created.
+ format: date-time
+ type: string
+ accountType:
+ x-addedInVersion: '50'
+ description: 'Indicates the type of account. For example, for a multi-account
+ card product.
+
+ Allowed values:
+
+ * notApplicable
+
+ * credit
+
+ * debit'
+ enum:
+ - notApplicable
+ - credit
+ - debit
+ type: string
+ addCardAttemptsDay:
+ description: Number of attempts the shopper tried to add a card to their
+ account in the last day.
+ format: int32
+ type: integer
+ deliveryAddressUsageDate:
+ description: Date the selected delivery address was first used.
+ format: date-time
+ type: string
+ deliveryAddressUsageIndicator:
+ description: 'Indicator for the length of time since this delivery address
+ was first used.
+
+ Allowed values:
+
+ * thisTransaction
+
+ * lessThan30Days
+
+ * from30To60Days
+
+ * moreThan60Days'
+ enum:
+ - thisTransaction
+ - lessThan30Days
+ - from30To60Days
+ - moreThan60Days
+ type: string
+ homePhone:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead.
+ description: Shopper's home phone number (including the country code).
+ type: string
+ mobilePhone:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead.
+ description: Shopper's mobile phone number (including the country code).
+ type: string
+ passwordChangeDate:
+ description: Date when the shopper last changed their password.
+ format: date-time
+ type: string
+ passwordChangeIndicator:
+ description: 'Indicator when the shopper has changed their password.
+
+ Allowed values:
+
+ * notApplicable
+
+ * thisTransaction
+
+ * lessThan30Days
+
+ * from30To60Days
+
+ * moreThan60Days'
+ enum:
+ - notApplicable
+ - thisTransaction
+ - lessThan30Days
+ - from30To60Days
+ - moreThan60Days
+ type: string
+ pastTransactionsDay:
+ description: Number of all transactions (successful and abandoned) from
+ this shopper in the past 24 hours.
+ format: int32
+ type: integer
+ pastTransactionsYear:
+ description: Number of all transactions (successful and abandoned) from
+ this shopper in the past year.
+ format: int32
+ type: integer
+ paymentAccountAge:
+ description: Date this payment method was added to the shopper's account.
+ format: date-time
+ type: string
+ paymentAccountIndicator:
+ description: 'Indicator for the length of time since this payment method
+ was added to this shopper''s account.
+
+ Allowed values:
+
+ * notApplicable
+
+ * thisTransaction
+
+ * lessThan30Days
+
+ * from30To60Days
+
+ * moreThan60Days'
+ enum:
+ - notApplicable
+ - thisTransaction
+ - lessThan30Days
+ - from30To60Days
+ - moreThan60Days
+ type: string
+ purchasesLast6Months:
+ description: Number of successful purchases in the last six months.
+ format: int32
+ type: integer
+ suspiciousActivity:
+ description: Whether suspicious activity was recorded on this account.
+ type: boolean
+ workPhone:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead.
+ description: Shopper's work phone number (including the country code).
+ type: string
+ type: object
+ AcctInfo:
+ properties:
+ chAccAgeInd:
+ description: "Length of time that the cardholder has had the account with\
+ \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\
+ \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\
+ \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\
+ \ than 60 days"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ maxLength: 2
+ minLength: 2
+ type: string
+ chAccChange:
+ description: "Date that the cardholder\u2019s account with the 3DS Requestor\
+ \ was last changed, including Billing or Shipping address, new payment\
+ \ account, or new user(s) added. \nFormat: **YYYYMMDD**"
+ type: string
+ chAccChangeInd:
+ description: "Length of time since the cardholder\u2019s account information\
+ \ with the 3DS Requestor was last changed, including Billing or Shipping\
+ \ address, new payment account, or new user(s) added. \nAllowed values:\n\
+ * **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\
+ \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\
+ \ than 60 days"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ maxLength: 2
+ minLength: 2
+ type: string
+ chAccPwChange:
+ description: "Date that cardholder\u2019s account with the 3DS Requestor\
+ \ had a password change or account reset. \nFormat: **YYYYMMDD**"
+ type: string
+ chAccPwChangeInd:
+ description: "Indicates the length of time since the cardholder\u2019s account\
+ \ with the 3DS Requestor had a password change or account reset. \nAllowed\
+ \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\
+ \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\
+ 60 days\n* **05** \u2014 More than 60 days"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ maxLength: 2
+ minLength: 2
+ type: string
+ chAccString:
+ description: "Date that the cardholder opened the account with the 3DS Requestor.\
+ \ \nFormat: **YYYYMMDD**"
+ type: string
+ nbPurchaseAccount:
+ description: 'Number of purchases with this cardholder account during the
+ previous six months. Max length: 4 characters.'
+ type: string
+ paymentAccAge:
+ description: "String that the payment account was enrolled in the cardholder\u2019\
+ s account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
+ type: string
+ paymentAccInd:
+ description: "Indicates the length of time that the payment account was\
+ \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\
+ Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\
+ \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\
+ * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ maxLength: 2
+ minLength: 2
+ type: string
+ provisionAttemptsDay:
+ description: 'Number of Add Card attempts in the last 24 hours. Max length:
+ 3 characters.'
+ type: string
+ shipAddressUsage:
+ description: "String when the shipping address used for this transaction\
+ \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**"
+ type: string
+ shipAddressUsageInd:
+ description: "Indicates when the shipping address used for this transaction\
+ \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\
+ \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\
+ \ 30\u201360 days\n* **04** \u2014 More than 60 days"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ maxLength: 2
+ minLength: 2
+ type: string
+ shipNameIndicator:
+ description: "Indicates if the Cardholder Name on the account is identical\
+ \ to the shipping Name used for this transaction. \nAllowed values:\n\
+ * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\
+ \ Account Name different to shipping Name"
+ enum:
+ - '01'
+ - '02'
+ maxLength: 2
+ minLength: 2
+ type: string
+ suspiciousAccActivity:
+ description: "Indicates whether the 3DS Requestor has experienced suspicious\
+ \ activity (including previous fraud) on the cardholder account. \nAllowed\
+ \ values:\n* **01** \u2014 No suspicious activity has been observed\n\
+ * **02** \u2014 Suspicious activity has been observed"
+ enum:
+ - '01'
+ - '02'
+ maxLength: 2
+ minLength: 2
+ type: string
+ txnActivityDay:
+ description: 'Number of transactions (successful and abandoned) for this
+ cardholder account with the 3DS Requestor across all payment accounts
+ in the previous 24 hours. Max length: 3 characters.'
+ maxLength: 3
+ type: string
+ txnActivityYear:
+ description: 'Number of transactions (successful and abandoned) for this
+ cardholder account with the 3DS Requestor across all payment accounts
+ in the previous year. Max length: 3 characters.'
+ maxLength: 3
+ type: string
+ type: object
+ AchDetails:
+ additionalProperties: false
+ properties:
+ bankAccountNumber:
+ description: The bank account number (without separators).
+ type: string
+ bankAccountType:
+ description: The bank account type (checking, savings...).
+ enum:
+ - balance
+ - checking
+ - deposit
+ - general
+ - other
+ - payment
+ - savings
+ type: string
+ bankLocationId:
+ description: The bank routing number of the account. The field value is
+ `nil` in most cases.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ encryptedBankAccountNumber:
+ description: Encrypted bank account number. The bank account number (without
+ separators).
+ type: string
+ encryptedBankLocationId:
+ description: Encrypted location id. The bank routing number of the account.
+ The field value is `nil` in most cases.
+ type: string
+ ownerName:
+ description: "The name of the bank account holder.\nIf you submit a name\
+ \ with non-Latin characters, we automatically replace some of them with\
+ \ corresponding Latin characters to meet the FATF recommendations. For\
+ \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\
+ \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\
+ \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\
+ \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\
+ \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\
+ \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\
+ > If provided details don't match the required format, the response returns\
+ \ the error message: 203 'Invalid bank account holder name'."
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: ach
+ description: '**ach**'
+ enum:
+ - ach
+ - ach_plaid
+ type: string
+ required:
+ - bankAccountNumber
+ title: ACH Direct Debit
+ type: object
+ AdditionalData3DSecure:
+ properties:
+ allow3DS2:
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS`
+ instead.
+ description: "Indicates if you are able to process 3D Secure 2 transactions\
+ \ natively on your payment page. Send this parameter when you are using\
+ \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\
+ \n > This parameter only indicates readiness to support native 3D Secure\
+ \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\
+ \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\
+ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\
+ \ support native 3D Secure 2 authentication. Setting this to true does\
+ \ not mean always applying 3D Secure 2. Adyen still selects the version\
+ \ of 3D Secure based on configuration to optimize authorisation rates\
+ \ and improve the shopper's experience.\n* **false** \u2013 Not ready\
+ \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\
+ \ Secure 2 to your shopper regardless of your configuration.\n"
+ type: string
+ challengeWindowSize:
+ description: "Dimensions of the 3DS2 challenge window to be displayed to\
+ \ the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n\
+ * **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size\
+ \ of 600x400\n* **05** - Fullscreen"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ type: string
+ executeThreeD:
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication)
+ instead
+ description: "Indicates if you want to perform 3D Secure authentication\
+ \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\
+ \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\
+ \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\
+ \ 3D Secure authentication. Note that this setting results in refusals\
+ \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\
+ \ national regulations. \n"
+ type: string
+ mpiImplementationType:
+ description: In case of Secure+, this field must be set to **CUPSecurePlus**.
+ type: string
+ scaExemption:
+ description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\
+ \ that you want to request for the transaction.\n\n Possible values:\n\
+ * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\
+ \ **transactionRiskAnalysis** "
+ type: string
+ threeDSVersion:
+ description: "Indicates your preference for the 3D Secure version. \n> If\
+ \ you use this parameter, you override the checks from Adyen's Authentication\
+ \ Engine. We recommend to use this field only if you have an extensive\
+ \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\
+ \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\
+ \ Apply 3D Secure version 2.2.0. If the issuer does not support version\
+ \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\
+ \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\
+ \ in the `ARes`, we will apply the fallback policy configured in your\
+ \ account. For example, if the configuration is to fall back to 3D Secure\
+ \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\
+ \ the BIN is not enrolled, you will receive an error.\n\n"
+ type: string
+ type: object
+ AdditionalDataAirline:
+ properties:
+ airline.agency_invoice_number:
+ description: 'The reference number for the invoice, issued by the agency.
+
+ * Encoding: ASCII
+
+ * minLength: 1 character
+
+ * maxLength: 6 characters'
+ type: string
+ airline.agency_plan_name:
+ description: 'The two-letter agency plan identifier.
+
+ * Encoding: ASCII
+
+ * minLength: 2 characters
+
+ * maxLength: 2 characters'
+ type: string
+ airline.airline_code:
+ description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
+ 3-digit accounting code (PAX) that identifies the carrier.
+
+ * Format: IATA 3-digit accounting code (PAX)
+
+ * Example: KLM = 074
+
+ * minLength: 3 characters
+
+ * maxLength: 3 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.airline_designator_code:
+ description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
+ 2-letter accounting code (PAX) that identifies the carrier.
+
+ * Encoding: ASCII
+
+ * Example: KLM = KL
+
+ * minLength: 2 characters
+
+ * maxLength: 2 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.boarding_fee:
+ description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Encoding: Numeric
+
+ * minLength: 1 character
+
+ * maxLength: 18 characters'
+ type: string
+ airline.computerized_reservation_system:
+ description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system)
+ used to make the reservation and purchase the ticket.
+
+ * Encoding: ASCII
+
+ * minLength: 4 characters
+
+ * maxLength: 4 characters'
+ type: string
+ airline.customer_reference_number:
+ description: 'The alphanumeric customer reference number.
+
+ * Encoding: ASCII
+
+ * maxLength: 20 characters
+
+ * If you send more than 20 characters, the customer reference number is
+ truncated
+
+ * Must not be all spaces'
+ type: string
+ airline.document_type:
+ description: 'A code that identifies the type of item bought. The description
+ of the code can appear on credit card statements.
+
+ * Encoding: ASCII
+
+ * Example: Passenger ticket = 01
+
+ * minLength: 2 characters
+
+ * maxLength: 2 characters'
+ type: string
+ airline.flight_date:
+ description: 'The flight departure date. Local time `(HH:mm)` is optional.
+
+ * Date format: `yyyy-MM-dd`
+
+ * Date and time format: `yyyy-MM-dd HH:mm`
+
+ * minLength: 10 characters
+
+ * maxLength: 16 characters'
+ type: string
+ airline.leg.carrier_code:
+ description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
+ 2-letter accounting code (PAX) that identifies the carrier.
+
+ This field is required if the airline data includes leg details.
+
+ * Example: KLM = KL
+
+ * minLength: 2 characters
+
+ * maxLength: 2 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.class_of_travel:
+ description: "A one-letter travel class identifier.\n The following are\
+ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\
+ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\
+ * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros."
+ type: string
+ airline.leg.date_of_travel:
+ description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\
+ \ format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n\
+ * maxLength: 16 characters"
+ type: string
+ airline.leg.depart_airport:
+ description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
+ three-letter airport code of the departure airport.
+
+ This field is required if the airline data includes leg details.
+
+
+ * Encoding: ASCII
+
+ * Example: Amsterdam = AMS
+
+ * minLength: 3 characters
+
+ * maxLength: 3 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.depart_tax:
+ description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax)
+ charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Encoding: Numeric
+
+ * minLength: 1
+
+ * maxLength: 12
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.destination_code:
+ description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
+ 3-letter airport code of the destination airport.
+
+ This field is required if the airline data includes leg details.
+
+ * Example: Amsterdam = AMS
+
+ * Encoding: ASCII
+
+ * minLength: 3 characters
+
+ * maxLength: 3 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.fare_base_code:
+ description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code),
+ alphanumeric.
+
+ * minLength: 1 character
+
+ * maxLength: 6 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.flight_number:
+ description: 'The flight identifier.
+
+ * minLength: 1 character
+
+ * maxLength: 5 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.leg.stop_over_code:
+ description: 'A one-letter code that indicates whether the passenger is
+ entitled to make a stopover. Can be a space, O if the passenger is entitled
+ to make a stopover, or X if they are not.
+
+ * Encoding: ASCII
+
+ * minLength: 1 character
+
+ * maxLength: 1 character'
+ type: string
+ airline.passenger.date_of_birth:
+ description: 'The passenger''s date of birth.
+
+
+ Date format: `yyyy-MM-dd`
+
+ * minLength: 10
+
+ * maxLength: 10'
+ type: string
+ airline.passenger.first_name:
+ description: 'The passenger''s first name.
+
+ > This field is required if the airline data includes passenger details
+ or leg details.
+
+ * Encoding: ASCII'
+ type: string
+ airline.passenger.last_name:
+ description: 'The passenger''s last name.
+
+ > This field is required if the airline data includes passenger details
+ or leg details.
+
+ * Encoding: ASCII'
+ type: string
+ airline.passenger.telephone_number:
+ description: 'The passenger''s telephone number, including country code.
+ This is an alphanumeric field that can include the ''+'' and ''-'' signs.
+
+ * Encoding: ASCII
+
+ * minLength: 3 characters
+
+ * maxLength: 30 characters'
+ type: string
+ airline.passenger.traveller_type:
+ description: 'The IATA passenger type code (PTC).
+
+ * Encoding: ASCII
+
+ * minLength: 3 characters
+
+ * maxLength: 6 characters'
+ type: string
+ airline.passenger_name:
+ description: "The passenger's name, initials, and title.\n* Format: last\
+ \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\
+ * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\
+ \ than 20 characters, the name is truncated\n* Must not be all spaces\
+ \ \n*Must not be all zeros."
+ type: string
+ airline.ticket_issue_address:
+ description: 'The address of the organization that issued the ticket.
+
+ * minLength: 0 characters
+
+ * maxLength: 16 characters'
+ type: string
+ airline.ticket_number:
+ description: 'The ticket''s unique identifier.
+
+ * minLength: 1 character
+
+ * maxLength: 15 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.travel_agency_code:
+ description: 'The unique identifier from IATA or ARC for the travel agency
+ that issues the ticket.
+
+ * Encoding: ASCII
+
+ * minLength: 1 character
+
+ * maxLength: 8 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ airline.travel_agency_name:
+ description: 'The name of the travel agency.
+
+
+ * Encoding: ASCII
+
+ * minLength: 1 character
+
+ * maxLength: 25 characters
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ required:
+ - airline.passenger_name
+ type: object
+ AdditionalDataCarRental:
+ properties:
+ carRental.checkOutDate:
+ description: 'The pick-up date.
+
+ * Date format: `yyyyMMdd`'
+ type: string
+ carRental.customerServiceTollFreeNumber:
+ description: 'The customer service phone number of the car rental company.
+
+ * Format: Alphanumeric
+
+ * maxLength: 17
+
+ * For US and CA numbers must be 10 characters in length
+
+ * Must not start with a space
+
+ * Must not contain any special characters such as + or -
+
+ *Must not be all zeros.'
+ type: string
+ carRental.daysRented:
+ description: 'Number of days for which the car is being rented.
+
+ * Format: Numeric
+
+ * maxLength: 4
+
+ * Must not be all spaces'
+ type: string
+ carRental.fuelCharges:
+ description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: Numeric
+
+ * maxLength: 12'
+ type: string
+ carRental.insuranceCharges:
+ description: 'Any insurance charges associated with the rental, in [minor
+ units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: Numeric
+
+ * maxLength: 12
+
+ * Must not be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.locationCity:
+ description: 'The city where the car is rented.
+
+ * Format: Alphanumeric
+
+ * maxLength: 18
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.locationCountry:
+ description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+ format.
+
+ * Format: Alphanumeric
+
+ * maxLength: 2'
+ type: string
+ carRental.locationStateProvince:
+ description: 'The state or province where the car is rented.
+
+ * Format: Alphanumeric
+
+ * maxLength: 2
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.noShowIndicator:
+ description: 'Indicates if the customer didn''t pick up their rental car.
+
+ * Y - Customer did not pick up their car
+
+ * N - Not applicable'
+ type: string
+ carRental.oneWayDropOffCharges:
+ description: 'The charge for not returning a car to the original rental
+ location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * maxLength: 12'
+ type: string
+ carRental.rate:
+ description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: Alphanumeric
+
+ * maxLength: 12'
+ type: string
+ carRental.rateIndicator:
+ description: 'Specifies whether the given rate is applied daily or weekly.
+
+ * D - Daily rate
+
+ * W - Weekly rate'
+ type: string
+ carRental.rentalAgreementNumber:
+ description: 'The rental agreement number for the car rental.
+
+ * Format: Alphanumeric
+
+ * maxLength: 9
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.rentalClassId:
+ description: 'The classification of the rental car.
+
+ * Format: Alphanumeric
+
+ * maxLength: 4
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.renterName:
+ description: 'The name of the person renting the car.
+
+ * Format: Alphanumeric
+
+ * maxLength: 26
+
+ * If you send more than 26 characters, the name is truncated
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.returnCity:
+ description: 'The city where the car must be returned.
+
+ * Format: Alphanumeric
+
+ * maxLength: 18
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.returnCountry:
+ description: 'The country where the car must be returned, in [ISO 3166-1
+ alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+
+ * Format: Alphanumeric
+
+ * maxLength: 2'
+ type: string
+ carRental.returnDate:
+ description: 'The last date to return the car by.
+
+ * Date format: `yyyyMMdd`
+
+ * maxLength: 8'
+ type: string
+ carRental.returnLocationId:
+ description: 'The agency code, phone number, or address abbreviation
+
+ * Format: Alphanumeric
+
+ * maxLength: 10
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.returnStateProvince:
+ description: 'The state or province where the car must be returned.
+
+ * Format: Alphanumeric
+
+ * maxLength: 3
+
+ * Must not start with a space or be all spaces
+
+ *Must not be all zeros.'
+ type: string
+ carRental.taxExemptIndicator:
+ description: 'Indicates if the goods or services were tax-exempt, or if
+ tax was not paid on them.
+
+
+ Values:
+
+ * Y - Goods or services were tax exempt
+
+ * N - Tax was not collected'
+ type: string
+ travelEntertainmentAuthData.duration:
+ description: 'Number of days the car is rented for. This should be included
+ in the auth message.
+
+ * Format: Numeric
+
+ * maxLength: 4'
+ type: string
+ travelEntertainmentAuthData.market:
+ description: 'Indicates what market-specific dataset will be submitted or
+ is being submitted. Value should be ''A'' for car rental. This should
+ be included in the auth message.
+
+ * Format: Alphanumeric
+
+ * maxLength: 1'
+ type: string
+ type: object
+ AdditionalDataCommon:
+ properties:
+ RequestedTestErrorResponseCode:
+ description: "Triggers test scenarios that allow to replicate certain communication\
+ \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\
+ \ wasn't a connection available to service the outgoing communication.\n\
+ This is a transient, retriable error since no messaging could be initiated\
+ \ to an issuing system (or third-party acquiring system). Therefore, the\
+ \ header Transient-Error: true is returned in the response. A subsequent\
+ \ request using the same idempotency key will be processed as if it was\
+ \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\
+ \ wrong during transmission of the message or receiving the response.\n\
+ This is a classified as non-transient because the message could have been\
+ \ received by the issuing party and been acted upon. No transient error\
+ \ header is returned. If using idempotency, the (error) response is stored\
+ \ as the final result for the idempotency key. Subsequent messages with\
+ \ the same idempotency key not be processed beyond returning the stored\
+ \ response."
+ type: string
+ allowPartialAuth:
+ description: "Set to true to authorise a part of the requested amount in\
+ \ case the cardholder does not have enough funds on their account. \n\
+ If a payment was partially authorised, the response includes resultCode:\
+ \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\
+ To enable this functionality, contact our Support Team."
+ type: string
+ authorisationType:
+ description: "Flags a card payment request for either pre-authorisation\
+ \ or final authorisation. For more information, refer to [Authorisation\
+ \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\
+ \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\
+ \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\
+ \ request to be handled as a final authorisation."
+ type: string
+ customRoutingFlag:
+ description: 'Allows you to determine or override the acquirer account that
+ should be used for the transaction.
+
+
+ If you need to process a payment with an acquirer different from a default
+ one, you can set up a corresponding configuration on the Adyen payments
+ platform. Then you can pass a custom routing flag in a payment request''s
+ additional data to target a specific acquirer.
+
+
+ To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ industryUsage:
+ description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\
+ \ this field denotes why the additional payment is made.\n\nPossible values:\n\
+ \n * **NoShow**: An incremental charge is carried out because of a no-show\
+ \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\
+ \ charge is carried out to process an additional payment after the original\
+ \ services have been rendered and the respective payment has been processed."
+ enum:
+ - NoShow
+ - DelayedCharge
+ type: string
+ manualCapture:
+ description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture)
+ for the transaction.
+ type: string
+ networkTxReference:
+ description: 'Allows you to link the transaction to the original or previous
+ one in a subscription/card-on-file chain. This field is required for token-based
+ transactions where Adyen does not tokenize the card.
+
+
+ Transaction identifier from card schemes, for example, Mastercard Trace
+ ID or the Visa Transaction ID.
+
+
+ Submit the original transaction ID of the contract in your payment request
+ if you are not tokenizing card details with Adyen and are making a merchant-initiated
+ transaction (MIT) for subsequent charges.
+
+
+ Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel`
+ **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction
+ is classified as MIT.'
+ type: string
+ overwriteBrand:
+ description: Boolean indicator that can be optionally used for performing
+ debit transactions on combo cards (for example, combo cards in Brazil).
+ This is not mandatory but we recommend that you set this to true if you
+ want to use the `selectedBrand` value to specify how to process the transaction.
+ type: string
+ subMerchantCity:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the city of
+ the actual merchant''s address.
+
+ * Format: alpha-numeric.
+
+ * Maximum length: 13 characters.'
+ type: string
+ subMerchantCountry:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the three-letter
+ country code of the actual merchant''s address.
+
+ * Format: alpha-numeric.
+
+ * Fixed length: 3 characters.'
+ type: string
+ subMerchantID:
+ description: 'This field contains an identifier of the actual merchant when
+ a transaction is submitted via a payment facilitator. The payment facilitator
+ must send in this unique ID.
+
+
+ A unique identifier per submerchant that is required if the transaction
+ is performed by a registered payment facilitator.
+
+ * Format: alpha-numeric.
+
+ * Fixed length: 15 characters.'
+ type: string
+ subMerchantName:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the name of
+ the actual merchant.
+
+ * Format: alpha-numeric.
+
+ * Maximum length: 22 characters.'
+ type: string
+ subMerchantPostalCode:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the postal code
+ of the actual merchant''s address.
+
+ * Format: alpha-numeric.
+
+ * Maximum length: 10 characters.'
+ type: string
+ subMerchantState:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator, and if applicable to the country. This
+ field must contain the state code of the actual merchant''s address.
+
+ * Format: alpha-numeric.
+
+ * Maximum length: 3 characters.'
+ type: string
+ subMerchantStreet:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the street of
+ the actual merchant''s address.
+
+ * Format: alpha-numeric.
+
+ * Maximum length: 60 characters.'
+ type: string
+ subMerchantTaxId:
+ description: 'This field is required if the transaction is performed by
+ a registered payment facilitator. This field must contain the tax ID of
+ the actual merchant.
+
+ * Format: alpha-numeric.
+
+ * Fixed length: 11 or 14 characters.'
+ type: string
+ type: object
+ AdditionalDataLevel23:
+ properties:
+ enhancedSchemeData.customerReference:
+ description: 'The customer code.
+
+ * Encoding: ASCII
+
+ * Max length: 25 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.destinationCountryCode:
+ description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
+ for the destination address.
+
+ * Encoding: ASCII
+
+ * Fixed length: 3 characters'
+ type: string
+ enhancedSchemeData.destinationPostalCode:
+ description: 'The postal code of the destination address.
+
+ * Encoding: ASCII
+
+ * Max length: 10 characters
+
+ * Must not start with a space'
+ type: string
+ enhancedSchemeData.destinationStateProvinceCode:
+ description: 'Destination state or province code.
+
+ * Encoding: ASCII
+
+ * Max length: 3 characters
+
+ * Must not start with a space'
+ type: string
+ enhancedSchemeData.dutyAmount:
+ description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ * Encoding: Numeric
+
+ * Max length: 12 characters'
+ type: string
+ enhancedSchemeData.freightAmount:
+ description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ * Encoding: Numeric
+
+ *Max length: 12 characters'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].commodityCode:
+ description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the
+ item.
+
+ * Encoding: ASCII
+
+ * Max length: 12 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].description:
+ description: 'A description of the item.
+
+ * Encoding: ASCII
+
+ * Max length: 26 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].discountAmount:
+ description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ * Encoding: Numeric
+
+ * Max length: 12 characters'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].productCode:
+ description: 'The product code.
+
+ * Encoding: ASCII.
+
+ * Max length: 12 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].quantity:
+ description: 'The number of items. Must be an integer greater than zero.
+
+ * Encoding: Numeric
+
+ * Max length: 12 characters
+
+ * Must not start with a space or be all spaces
+
+
+ '
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].totalAmount:
+ description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ * Max length: 12 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure:
+ description: 'The unit of measurement for an item.
+
+ * Encoding: ASCII
+
+
+ Max length: 3 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.itemDetailLine[itemNr].unitPrice:
+ description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ * Encoding: Numeric
+
+ * Max length: 12 characters
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.orderDate:
+ description: 'The order date.
+
+ * Format: `ddMMyy`
+
+ * Encoding: ASCII
+
+ * Max length: 6 characters'
+ type: string
+ enhancedSchemeData.shipFromPostalCode:
+ description: 'The postal code of the address the item is shipped from.
+
+ * Encoding: ASCII
+
+ * Max length: 10 characters
+
+ * Must not start with a space or be all spaces
+
+ * Must not be all zeros.'
+ type: string
+ enhancedSchemeData.totalTaxAmount:
+ description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * For example, 2000 means USD 20.00.
+
+ *Encoding: Numeric
+
+ *Max length: 12 characters
+
+ * Must not be all zeros.'
+ type: string
+ type: object
+ AdditionalDataLodging:
+ properties:
+ lodging.checkInDate:
+ description: 'The arrival date.
+
+ * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
+ type: string
+ lodging.checkOutDate:
+ description: 'The departure date.
+
+ * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
+ type: string
+ lodging.customerServiceTollFreeNumber:
+ description: 'The toll-free phone number for the lodging.
+
+ * Format: numeric
+
+ * Max length: 17 characters.
+
+ * For US and CA numbers must be 10 characters in length
+
+ * Must not start with a space
+
+ * Must not contain any special characters such as + or -
+
+ *Must not be all zeros.'
+ type: string
+ lodging.fireSafetyActIndicator:
+ description: 'Identifies that the facility complies with the Hotel and Motel
+ Fire Safety Act of 1990. Must be ''Y'' or ''N''.
+
+ * Format: alphabetic
+
+ * Max length: 1 character'
+ type: string
+ lodging.folioCashAdvances:
+ description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: numeric
+
+ * Max length: 12 characters'
+ type: string
+ lodging.folioNumber:
+ description: "The card acceptor\u2019s internal invoice or billing ID reference\
+ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\
+ *Must not be all zeros."
+ type: string
+ lodging.foodBeverageCharges:
+ description: 'Any charges for food and beverages associated with the booking,
+ in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: numeric
+
+ * Max length: 12 characters'
+ type: string
+ lodging.noShowIndicator:
+ description: "Indicates if the customer didn't check in for their booking.\n\
+ \ Possible values: \n* **Y**: the customer didn't check in \n* **N**:\
+ \ the customer checked in"
+ type: string
+ lodging.prepaidExpenses:
+ description: 'The prepaid expenses for the booking.
+
+ * Format: numeric
+
+ * Max length: 12 characters'
+ type: string
+ lodging.propertyPhoneNumber:
+ description: 'The lodging property location''s phone number.
+
+ * Format: numeric.
+
+ * Min length: 10 characters
+
+ * Max length: 17 characters
+
+ * For US and CA numbers must be 10 characters in length
+
+ * Must not start with a space
+
+ * Must not contain any special characters such as + or -
+
+ *Must not be all zeros.'
+ type: string
+ lodging.room1.numberOfNights:
+ description: 'The total number of nights the room is booked for.
+
+ * Format: numeric
+
+ * Must be a number between 0 and 99
+
+ * Max length: 4 characters'
+ type: string
+ lodging.room1.rate:
+ description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: numeric
+
+ * Max length: 12 characters
+
+ * Must not be a negative number'
+ type: string
+ lodging.totalRoomTax:
+ description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: numeric
+
+ * Max length: 12 characters
+
+ * Must not be a negative number'
+ type: string
+ lodging.totalTax:
+ description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * Format: numeric
+
+ * Max length: 12 characters
+
+ * Must not be a negative number'
+ type: string
+ travelEntertainmentAuthData.duration:
+ description: 'The number of nights. This should be included in the auth
+ message.
+
+ * Format: numeric
+
+ * Max length: 4 characters'
+ type: string
+ travelEntertainmentAuthData.market:
+ description: 'Indicates what market-specific dataset will be submitted.
+ Must be ''H'' for Hotel. This should be included in the auth message.
+
+
+ * Format: alphanumeric
+
+ * Max length: 1 character'
+ type: string
+ type: object
+ AdditionalDataOpenInvoice:
+ properties:
+ openinvoicedata.merchantData:
+ description: 'Holds different merchant data points like product, purchase,
+ customer, and so on. It takes data in a Base64 encoded string.
+
+
+ The `merchantData` parameter needs to be added to the `openinvoicedata`
+ signature at the end.
+
+
+ Since the field is optional, if it''s not included it does not impact
+ computing the merchant signature.
+
+
+ Applies only to Klarna.
+
+
+ You can contact Klarna for the format and structure of the string.'
+ type: string
+ openinvoicedata.numberOfLines:
+ description: 'The number of invoice lines included in `openinvoicedata`.
+
+
+ There needs to be at least one line, so `numberOfLines` needs to be at
+ least 1.'
+ type: string
+ openinvoicedata.recipientFirstName:
+ description: First name of the recipient. If the delivery address and the
+ billing address are different, specify the `recipientFirstName` and `recipientLastName`
+ to share the delivery address with Klarna. Otherwise, only the billing
+ address is shared with Klarna.
+ type: string
+ openinvoicedata.recipientLastName:
+ description: Last name of the recipient. If the delivery address and the
+ billing address are different, specify the `recipientFirstName` and `recipientLastName`
+ to share the delivery address with Klarna. Otherwise, only the billing
+ address is shared with Klarna.
+ type: string
+ openinvoicedataLine[itemNr].currencyCode:
+ description: The three-character ISO currency code.
+ type: string
+ openinvoicedataLine[itemNr].description:
+ description: A text description of the product the invoice line refers to.
+ type: string
+ openinvoicedataLine[itemNr].itemAmount:
+ description: 'The price for one item in the invoice line, represented in
+ minor units.
+
+
+ The due amount for the item, VAT excluded.'
+ type: string
+ openinvoicedataLine[itemNr].itemId:
+ description: A unique id for this item. Required for RatePay if the description
+ of each item is not unique.
+ type: string
+ openinvoicedataLine[itemNr].itemVatAmount:
+ description: The VAT due for one item in the invoice line, represented in
+ minor units.
+ type: string
+ openinvoicedataLine[itemNr].itemVatPercentage:
+ description: 'The VAT percentage for one item in the invoice line, represented
+ in minor units.
+
+
+ For example, 19% VAT is specified as 1900.'
+ type: string
+ openinvoicedataLine[itemNr].numberOfItems:
+ description: The number of units purchased of a specific product.
+ type: string
+ openinvoicedataLine[itemNr].returnShippingCompany:
+ description: Name of the shipping company handling the the return shipment.
+ type: string
+ openinvoicedataLine[itemNr].returnTrackingNumber:
+ description: The tracking number for the return of the shipment.
+ type: string
+ openinvoicedataLine[itemNr].returnTrackingUri:
+ description: URI where the customer can track the return of their shipment.
+ type: string
+ openinvoicedataLine[itemNr].shippingCompany:
+ description: Name of the shipping company handling the delivery.
+ type: string
+ openinvoicedataLine[itemNr].shippingMethod:
+ description: Shipping method.
+ type: string
+ openinvoicedataLine[itemNr].trackingNumber:
+ description: The tracking number for the shipment.
+ type: string
+ openinvoicedataLine[itemNr].trackingUri:
+ description: URI where the customer can track their shipment.
+ type: string
+ type: object
+ AdditionalDataOpi:
+ properties:
+ opi.includeTransToken:
+ description: 'Optional boolean indicator. Set to **true** if you want an
+ ecommerce transaction to return an `opi.transToken` as additional data
+ in the response.
+
+
+ You can store this Oracle Payment Interface token in your Oracle Opera
+ database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
+ type: string
+ type: object
+ AdditionalDataRatepay:
+ properties:
+ ratepay.installmentAmount:
+ description: Amount the customer has to pay each month.
+ type: string
+ ratepay.interestRate:
+ description: Interest rate of this installment.
+ type: string
+ ratepay.lastInstallmentAmount:
+ description: Amount of the last installment.
+ type: string
+ ratepay.paymentFirstday:
+ description: Calendar day of the first payment.
+ type: string
+ ratepaydata.deliveryDate:
+ description: Date the merchant delivered the goods to the customer.
+ type: string
+ ratepaydata.dueDate:
+ description: Date by which the customer must settle the payment.
+ type: string
+ ratepaydata.invoiceDate:
+ description: Invoice date, defined by the merchant. If not included, the
+ invoice date is set to the delivery date.
+ type: string
+ ratepaydata.invoiceId:
+ description: Identification name or number for the invoice, defined by the
+ merchant.
+ type: string
+ type: object
+ AdditionalDataRetry:
+ properties:
+ retry.chainAttemptNumber:
+ description: 'The number of times the transaction (not order) has been retried
+ between different payment service providers. For instance, the `chainAttemptNumber`
+ set to 2 means that this transaction has been recently tried on another
+ provider before being sent to Adyen.
+
+
+ > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
+ and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
+ to facilitate linking payment attempts together.'
+ type: string
+ retry.orderAttemptNumber:
+ description: 'The index of the attempt to bill a particular order, which
+ is identified by the `merchantOrderReference` field. For example, if a
+ recurring transaction fails and is retried one day later, then the order
+ number for these attempts would be 1 and 2, respectively.
+
+
+ > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
+ and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
+ to facilitate linking payment attempts together.'
+ type: string
+ retry.skipRetry:
+ description: 'The Boolean value indicating whether Adyen should skip or
+ retry this transaction, if possible.
+
+
+ > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`,
+ and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference`
+ to facilitate linking payment attempts together.'
+ type: string
+ type: object
+ AdditionalDataRisk:
+ properties:
+ riskdata.[customFieldName]:
+ description: The data for your custom risk field. For more information,
+ refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).
+ type: string
+ riskdata.basket.item[itemNr].amountPerItem:
+ description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ type: string
+ riskdata.basket.item[itemNr].brand:
+ description: Brand of the item.
+ type: string
+ riskdata.basket.item[itemNr].category:
+ description: Category of the item.
+ type: string
+ riskdata.basket.item[itemNr].color:
+ description: Color of the item.
+ type: string
+ riskdata.basket.item[itemNr].currency:
+ description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
+ type: string
+ riskdata.basket.item[itemNr].itemID:
+ description: ID of the item.
+ type: string
+ riskdata.basket.item[itemNr].manufacturer:
+ description: Manufacturer of the item.
+ type: string
+ riskdata.basket.item[itemNr].productTitle:
+ description: A text description of the product the invoice line refers to.
+ type: string
+ riskdata.basket.item[itemNr].quantity:
+ description: Quantity of the item purchased.
+ type: string
+ riskdata.basket.item[itemNr].receiverEmail:
+ description: Email associated with the given product in the basket (usually
+ in electronic gift cards).
+ type: string
+ riskdata.basket.item[itemNr].size:
+ description: Size of the item.
+ type: string
+ riskdata.basket.item[itemNr].sku:
+ description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).'
+ type: string
+ riskdata.basket.item[itemNr].upc:
+ description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).'
+ type: string
+ riskdata.promotions.promotion[itemNr].promotionCode:
+ description: Code of the promotion.
+ type: string
+ riskdata.promotions.promotion[itemNr].promotionDiscountAmount:
+ description: The discount amount of the promotion, represented in [minor
+ units](https://docs.adyen.com/development-resources/currency-codes).
+ type: string
+ riskdata.promotions.promotion[itemNr].promotionDiscountCurrency:
+ description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
+ type: string
+ riskdata.promotions.promotion[itemNr].promotionDiscountPercentage:
+ description: 'Promotion''s percentage discount. It is represented in percentage
+ value and there is no need to include the ''%'' sign.
+
+
+ e.g. for a promotion discount of 30%, the value of the field should be
+ 30.'
+ type: string
+ riskdata.promotions.promotion[itemNr].promotionName:
+ description: Name of the promotion.
+ type: string
+ riskdata.riskProfileReference:
+ description: Reference number of the risk profile that you want to apply
+ to the payment. If not provided or left blank, the merchant-level account's
+ default risk profile will be applied to the payment. For more information,
+ see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).
+ type: string
+ riskdata.skipRisk:
+ description: If this parameter is provided with the value **true**, risk
+ checks for the payment request are skipped and the transaction will not
+ get a risk score.
+ type: string
+ type: object
+ AdditionalDataRiskStandalone:
+ properties:
+ PayPal.CountryCode:
+ description: Shopper's country of residence in the form of ISO standard
+ 3166 2-character country codes.
+ type: string
+ PayPal.EmailId:
+ description: Shopper's email.
+ type: string
+ PayPal.FirstName:
+ description: Shopper's first name.
+ type: string
+ PayPal.LastName:
+ description: Shopper's last name.
+ type: string
+ PayPal.PayerId:
+ description: 'Unique PayPal Customer Account identification number. Character
+ length and limitations: 13 single-byte alphanumeric characters.'
+ type: string
+ PayPal.Phone:
+ description: Shopper's phone number.
+ type: string
+ PayPal.ProtectionEligibility:
+ description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\
+ \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\
+ \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\
+ \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\
+ \ \u2014 Merchant is not protected under the Seller Protection Policy."
+ type: string
+ PayPal.TransactionId:
+ description: Unique transaction ID of the payment.
+ type: string
+ avsResultRaw:
+ description: 'Raw AVS result received from the acquirer, where available.
+ Example: D'
+ type: string
+ bin:
+ description: The Bank Identification Number of a credit card, which is the
+ first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).
+ type: string
+ cvcResultRaw:
+ description: 'Raw CVC result received from the acquirer, where available.
+ Example: 1'
+ type: string
+ riskToken:
+ description: Unique identifier or token for the shopper's card details.
+ type: string
+ threeDAuthenticated:
+ description: 'A Boolean value indicating whether 3DS authentication was
+ completed on this payment. Example: true'
+ type: string
+ threeDOffered:
+ description: 'A Boolean value indicating whether 3DS was offered for this
+ payment. Example: true'
+ type: string
+ tokenDataType:
+ description: 'Required for PayPal payments only. The only supported value
+ is: **paypal**.'
+ type: string
+ type: object
+ AdditionalDataSubMerchant:
+ properties:
+ subMerchant.numberOfSubSellers:
+ description: Required for transactions performed by registered payment facilitators.
+ Indicates the number of sub-merchants contained in the request. For example,
+ **3**.
+ type: string
+ subMerchant.subSeller[subSellerNr].city:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The city of the sub-merchant''s address.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 13 characters'
+ type: string
+ subMerchant.subSeller[subSellerNr].country:
+ description: "Required for transactions performed by registered payment\
+ \ facilitators. The three-letter country code of the sub-merchant's address.\
+ \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\
+ * Fixed length: 3 characters"
+ type: string
+ subMerchant.subSeller[subSellerNr].id:
+ description: "Required for transactions performed by registered payment\
+ \ facilitators. A unique identifier that you create for the sub-merchant,\
+ \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\
+ * Maximum length: 15 characters"
+ type: string
+ subMerchant.subSeller[subSellerNr].mcc:
+ description: "Required for transactions performed by registered payment\
+ \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\
+ \ \n* Format: Numeric\n* Fixed length: 4 digits"
+ type: string
+ subMerchant.subSeller[subSellerNr].name:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The name of the sub-merchant. Based on scheme specifications,
+ this value will overwrite the shopper statement that will appear in the
+ card statement.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 22 characters'
+ type: string
+ subMerchant.subSeller[subSellerNr].postalCode:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The postal code of the sub-merchant''s address, without
+ dashes.
+
+ * Format: Numeric
+
+ * Fixed length: 8 digits'
+ type: string
+ subMerchant.subSeller[subSellerNr].state:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The state code of the sub-merchant''s address, if applicable
+ to the country.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 2 characters'
+ type: string
+ subMerchant.subSeller[subSellerNr].street:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The street name and house number of the sub-merchant''s
+ address.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 60 characters'
+ type: string
+ subMerchant.subSeller[subSellerNr].taxId:
+ description: 'Required for transactions performed by registered payment
+ facilitators. The tax ID of the sub-merchant.
+
+ * Format: Numeric
+
+ * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
+ type: string
+ type: object
+ AdditionalDataTemporaryServices:
+ properties:
+ enhancedSchemeData.customerReference:
+ description: 'The customer code, if supplied by a customer.
+
+ * Encoding: ASCII
+
+ * maxLength: 25'
+ type: string
+ enhancedSchemeData.employeeName:
+ description: "The name or ID of the person working in a temporary capacity.\n\
+ * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros."
+ type: string
+ enhancedSchemeData.jobDescription:
+ description: "The job description of the person working in a temporary capacity.\n\
+ * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros."
+ type: string
+ enhancedSchemeData.regularHoursRate:
+ description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes).
+
+ * maxLength: 7
+
+ * Must not be empty
+
+ * Can be all zeros'
+ type: string
+ enhancedSchemeData.regularHoursWorked:
+ description: 'The hours worked.
+
+ * maxLength: 7
+
+ * Must not be empty
+
+ * Can be all zeros'
+ type: string
+ enhancedSchemeData.requestName:
+ description: 'The name of the person requesting temporary services.
+
+ * maxLength: 40
+
+ * Must not be all zeros
+
+ * Must not be all spaces'
+ type: string
+ enhancedSchemeData.tempStartDate:
+ description: 'The billing period start date.
+
+ * Format: ddMMyy
+
+ * maxLength: 6'
+ type: string
+ enhancedSchemeData.tempWeekEnding:
+ description: 'The billing period end date.
+
+ * Format: ddMMyy
+
+ * maxLength: 6'
+ type: string
+ enhancedSchemeData.totalTaxAmount:
+ description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ For example, 2000 means USD 20.00
+
+ * maxLength: 12'
+ type: string
+ type: object
+ AdditionalDataWallets:
+ properties:
+ androidpay.token:
+ description: The Android Pay token retrieved from the SDK.
+ type: string
+ masterpass.transactionId:
+ description: The Mastercard Masterpass Transaction ID retrieved from the
+ SDK.
+ type: string
+ payment.token:
+ description: The Apple Pay token retrieved from the SDK.
+ type: string
+ paywithgoogle.token:
+ description: The Google Pay token retrieved from the SDK.
+ type: string
+ samsungpay.token:
+ description: The Samsung Pay token retrieved from the SDK.
+ type: string
+ visacheckout.callId:
+ description: The Visa Checkout Call ID retrieved from the SDK.
+ type: string
+ type: object
+ Address:
+ properties:
+ city:
+ description: 'The name of the city. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ country:
+ description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
+ **US**.
+
+ > If you don''t know the country or are not collecting the country from
+ the shopper, provide `country` as `ZZ`.'
+ type: string
+ houseNumberOrName:
+ description: 'The number or name of the house. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ postalCode:
+ description: A maximum of five digits for an address in the US, or a maximum
+ of ten characters for an address in all other countries.
+ type: string
+ stateOrProvince:
+ description: 'The two-character ISO 3166-2 state or province code. For example,
+ **CA** in the US or **ON** in Canada.
+
+ > Required for the US and Canada.'
+ type: string
+ street:
+ description: 'The name of the street. Maximum length: 3000 characters.
+
+ > The house number should not be included in this field; it should be
+ separately provided via `houseNumberOrName`.'
+ maxLength: 3000
+ type: string
+ required:
+ - street
+ - houseNumberOrName
+ - city
+ - postalCode
+ - country
+ type: object
+ AfterpayDetails:
+ additionalProperties: false
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ deliveryAddress:
+ description: The address where the goods should be delivered.
+ type: string
+ personalDetails:
+ description: Shopper name, date of birth, phone number, and email address.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: afterpay_default
+ description: '**afterpay_default**'
+ enum:
+ - afterpay_default
+ - afterpaytouch
+ - afterpay_b2b
+ - clearpay
+ type: string
+ required:
+ - type
+ title: Afterpay
+ type: object
+ AmazonPayDetails:
+ additionalProperties: false
+ properties:
+ amazonPayToken:
+ description: This is the `amazonPayToken` that you obtained from the [Get
+ Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session)
+ response. This token is used for API only integration specifically.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ checkoutSessionId:
+ description: The `checkoutSessionId` is used to identify the checkout session
+ at the Amazon Pay side. This field is required only for drop-in and components
+ integration, where it replaces the amazonPayToken.
+ type: string
+ type:
+ default: amazonpay
+ description: '**amazonpay**'
+ enum:
+ - amazonpay
+ type: string
+ title: Amazon Pay
+ type: object
+ Amount:
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ - currency
+ type: object
+ AndroidPayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ type:
+ default: androidpay
+ description: '**androidpay**'
+ enum:
+ - androidpay
+ type: string
+ title: Android Pay
+ type: object
+ ApplePayDetails:
+ additionalProperties: false
+ properties:
+ applePayToken:
+ description: The stringified and base64 encoded `paymentData` you retrieved
+ from the Apple framework.
+ maxLength: 10000
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: applepay
+ description: '**applepay**'
+ enum:
+ - applepay
+ type: string
+ required:
+ - applePayToken
+ title: Apple Pay
+ type: object
+ ApplePayDonations:
+ additionalProperties: false
+ properties:
+ applePayToken:
+ description: The stringified and base64 encoded `paymentData` you retrieved
+ from the Apple framework.
+ maxLength: 10000
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: applepay
+ description: '**applepay**'
+ enum:
+ - applepay
+ type: string
+ required:
+ - applePayToken
+ title: Apple Pay
+ type: object
+ ApplePaySessionRequest:
+ properties:
+ displayName:
+ description: 'This is the name that your shoppers will see in the Apple
+ Pay interface.
+
+
+ The value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)
+ response.'
+ type: string
+ domainName:
+ description: 'The domain name you provided when you added Apple Pay in your
+ Customer Area.
+
+
+ This must match the `window.location.hostname` of the web shop.'
+ type: string
+ merchantIdentifier:
+ description: 'Your merchant identifier registered with Apple Pay.
+
+
+ Use the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)
+ response.'
+ type: string
+ required:
+ - domainName
+ - merchantIdentifier
+ - displayName
+ type: object
+ ApplePaySessionResponse:
+ properties:
+ data:
+ description: Base64 encoded data you need to [complete the Apple Pay merchant
+ validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).
+ type: string
+ required:
+ - data
+ type: object
+ ApplicationInfo:
+ properties:
+ adyenLibrary:
+ description: Adyen-developed software, such as libraries and plugins, used
+ to interact with the Adyen API. For example, Magento plugin, Java API
+ library, etc.
+ $ref: '#/components/schemas/CommonField'
+ adyenPaymentSource:
+ description: Adyen-developed software to get payment details. For example,
+ Checkout SDK, Secured Fields SDK, etc.
+ $ref: '#/components/schemas/CommonField'
+ externalPlatform:
+ description: Third-party developed platform used to initiate payment requests.
+ For example, Magento, Zuora, etc.
+ $ref: '#/components/schemas/ExternalPlatform'
+ merchantApplication:
+ description: Merchant developed software, such as cashier application, used
+ to interact with the Adyen API.
+ $ref: '#/components/schemas/CommonField'
+ merchantDevice:
+ description: Merchant device information.
+ $ref: '#/components/schemas/MerchantDevice'
+ shopperInteractionDevice:
+ description: Shopper interaction device, such as terminal, mobile device
+ or web browser, to initiate payment requests.
+ $ref: '#/components/schemas/ShopperInteractionDevice'
+ type: object
+ AuthenticationData:
+ properties:
+ attemptAuthentication:
+ x-addedInVersion: '69'
+ description: 'Indicates when 3D Secure authentication should be attempted.
+ This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
+
+
+ Possible values:
+
+
+ * **always**: Perform 3D Secure authentication.
+
+ * **never**: Don''t perform 3D Secure authentication. If PSD2 SCA or other
+ national regulations require authentication, the transaction gets declined.'
+ enum:
+ - always
+ - never
+ type: string
+ authenticationOnly:
+ x-addedInVersion: '69'
+ default: false
+ description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+
+ Default: **false**.'
+ type: boolean
+ threeDSRequestData:
+ x-addedInVersion: '69'
+ description: Object with additional parameters for the 3D Secure authentication
+ flow.
+ $ref: '#/components/schemas/ThreeDSRequestData'
+ type: object
+ Avs:
+ properties:
+ addressEditable:
+ description: Indicates whether the shopper is allowed to modify the billing
+ address for the current payment request.
+ type: boolean
+ enabled:
+ description: "Specifies whether the shopper should enter their billing address\
+ \ during checkout.\n\nAllowed values:\n* yes \u2014 Perform AVS checks\
+ \ for every card payment.\n* automatic \u2014 Perform AVS checks only\
+ \ when required to optimize the conversion rate.\n* no \u2014 Do not perform\
+ \ AVS checks."
+ enum:
+ - 'yes'
+ - 'no'
+ - automatic
+ type: string
+ type: object
+ BacsDirectDebitDetails:
+ additionalProperties: false
+ properties:
+ bankAccountNumber:
+ x-addedInVersion: '65'
+ description: The bank account number (without separators).
+ type: string
+ bankLocationId:
+ x-addedInVersion: '65'
+ description: The bank routing number of the account.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ holderName:
+ x-addedInVersion: '65'
+ description: The name of the bank account holder.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: directdebit_GB
+ description: '**directdebit_GB**'
+ enum:
+ - directdebit_GB
+ type: string
+ title: BACS Direct Debit
+ type: object
+ BalanceCheckRequest:
+ properties:
+ accountInfo:
+ x-addedInVersion: '40'
+ description: 'Shopper account information for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/AccountInfo'
+ additionalAmount:
+ description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ request to use a non-zero value, assign this value to `additionalAmount`
+ (while the amount must be still set to 0 to trigger BIN or card verification).
+
+ Required to be in the same currency as the `amount`. '
+ $ref: '#/components/schemas/Amount'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ amount:
+ description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
+ For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ requests, set amount to 0 (zero).
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ x-addedInVersion: '40'
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ billingAddress:
+ x-addedInVersion: '4'
+ description: 'The address where to send the invoice.
+
+ > The `billingAddress` object is required in the following scenarios.
+ Include all of the fields within this object.
+
+ >* For 3D Secure 2 transactions in all browser-based and mobile implementations.
+
+ >* For cross-border payouts to and from Canada.'
+ $ref: '#/components/schemas/Address'
+ browserInfo:
+ description: 'The shopper''s browser information.
+
+ > For 3D Secure, the full object is required for web integrations. For
+ mobile app integrations, include the `userAgent` and `acceptHeader` fields
+ to indicate that your integration can support a redirect in case a payment
+ is routed to 3D Secure 1.'
+ $ref: '#/components/schemas/BrowserInfo'
+ captureDelayHours:
+ x-addedInVersion: '2'
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ dateOfBirth:
+ x-addedInVersion: '7'
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date
+ type: string
+ dccQuote:
+ description: The forex quote as returned in the response of the forex service.
+ $ref: '#/components/schemas/ForexQuote'
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/Address'
+ deliveryDate:
+ x-addedInVersion: '8'
+ description: 'The date and time the purchased goods should be delivered.
+
+
+ Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
+
+
+ Example: 2017-07-17T13:42:40.428+01:00'
+ format: date-time
+ type: string
+ deviceFingerprint:
+ x-addedInVersion: '2'
+ description: A string containing the shopper's device fingerprint. For more
+ information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
+ maxLength: 5000
+ type: string
+ fraudOffset:
+ description: An integer value that is added to the normal fraud score. The
+ value can be either positive or negative.
+ format: int32
+ type: integer
+ installments:
+ x-addedInVersion: '4'
+ description: Contains installment settings. For more information, refer
+ to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
+ $ref: '#/components/schemas/Installments'
+ localizedShopperStatement:
+ x-addedInVersion: '68'
+ additionalProperties:
+ type: string
+ description: "The `localizedShopperStatement` field lets you use dynamic\
+ \ values for your shopper statement in a local character set.\nIf not\
+ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\
+ \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\
+ \ and Mastercard payments in Japan using Japanese cards. This character\
+ \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\
+ \ special characters. \n* Half-width or full-width characters."
+ type: object
+ mcc:
+ x-addedInVersion: '12'
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantOrderReference:
+ x-addedInVersion: '9'
+ description: 'This reference allows linking multiple transactions to each
+ other for reporting purposes (i.e. order auth-rate). The reference should
+ be unique per billing cycle.
+
+ The same merchant order reference should never be reused after the first
+ authorised attempt. If used, this field should be supplied for all incoming
+ authorisations.
+
+ > We strongly recommend you send the `merchantOrderReference` value to
+ benefit from linking payment requests when authorisation retries take
+ place. In addition, we recommend you provide `retry.orderAttemptNumber`,
+ `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
+ type: string
+ merchantRiskIndicator:
+ x-addedInVersion: '40'
+ description: 'Additional risk fields for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/MerchantRiskIndicator'
+ metadata:
+ x-addedInVersion: '17'
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request. When exceeding, the "177" error
+ occurs: "Metadata size exceeds limit".
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ orderReference:
+ description: When you are doing multiple partial (gift card) payments, this
+ is the `pspReference` of the first payment. We use this to link the multiple
+ payments to each other. As your own reference for linking multiple payments,
+ use the `merchantOrderReference`instead.
+ type: string
+ paymentMethod:
+ additionalProperties:
+ type: string
+ description: The collection that contains the type of the payment method
+ and its specific information.
+ type: object
+ recurring:
+ description: The recurring settings for the payment. Use this property when
+ you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).
+ $ref: '#/components/schemas/Recurring'
+ recurringProcessingModel:
+ x-addedInVersion: '30'
+ description: "Defines a recurring payment type. Required when creating a\
+ \ token to store payment details or using stored payment details.\nAllowed\
+ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
+ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
+ \ a card-on-file (CoF) transaction, card details are stored to enable\
+ \ one-click or omnichannel journeys, or simply to streamline the checkout\
+ \ process. Any subscription not following a fixed schedule is also considered\
+ \ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
+ \ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
+ \ schedule and/or have variable amounts. For example, automatic top-ups\
+ \ when a cardholder's balance drops below a certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ reference:
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement.
+
+ If you need to provide multiple references for a transaction, separate
+ them with hyphens ("-").
+
+ Maximum length: 80 characters.'
+ type: string
+ selectedBrand:
+ description: 'Some payment methods require defining a value for this field
+ to specify how to process the transaction.
+
+
+ For the Bancontact payment method, it can be set to:
+
+ * `maestro` (default), to be processed like a Maestro card, or
+
+ * `bcmc`, to be processed like a Bancontact card.'
+ type: string
+ selectedRecurringDetailReference:
+ description: The `recurringDetailReference` you want to use for this payment.
+ The value `LATEST` can be used to select the most recently stored recurring
+ detail.
+ type: string
+ sessionId:
+ description: A session ID used to identify a payment session.
+ type: string
+ shopperEmail:
+ description: 'The shopper''s email address. We recommend that you provide
+ this data, as it is used in velocity fraud checks.
+
+ > For 3D Secure 2 transactions, schemes require `shopperEmail` for all
+ browser-based and mobile implementations.'
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ x-addedInVersion: '7'
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ x-addedInVersion: '7'
+ description: The shopper's full name.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ type: string
+ shopperStatement:
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ socialSecurityNumber:
+ x-addedInVersion: '4'
+ description: The shopper's social security number.
+ type: string
+ splits:
+ x-addedInVersion: '37'
+ description: An array of objects specifying how the payment should be split
+ when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)
+ or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ x-addedInVersion: '23'
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ maxLength: 16
+ minLength: 1
+ type: string
+ telephoneNumber:
+ x-addedInVersion: '7'
+ description: The shopper's telephone number.
+ type: string
+ threeDS2RequestData:
+ x-addedInVersion: '40'
+ description: Request fields for 3D Secure 2. To check if any of the following
+ fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
+ or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
+ $ref: '#/components/schemas/ThreeDS2RequestData'
+ threeDSAuthenticationOnly:
+ x-addedInVersion: '50'
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ totalsGroup:
+ x-addedInVersion: '23'
+ description: The reference value to aggregate sales totals in reporting.
+ When not specified, the store field is used (if available).
+ maxLength: 16
+ minLength: 1
+ type: string
+ trustedShopper:
+ x-addedInVersion: '37'
+ description: Set to true if the payment should be routed to a trusted MID.
+ type: boolean
+ required:
+ - merchantAccount
+ - amount
+ - paymentMethod
+ type: object
+ BalanceCheckResponse:
+ properties:
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
+ - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCard'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
+ - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
+ - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
+ - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
+ - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
+ - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
+ description: 'Contains additional information about the payment. Some data
+ fields are included only if you select them first: Go to **Customer Area**
+ > **Developers** > **Additional data**.'
+ type: object
+ balance:
+ description: The balance for the payment method.
+ $ref: '#/components/schemas/Amount'
+ fraudResult:
+ description: The fraud result properties of the payment.
+ $ref: '#/components/schemas/FraudResult'
+ pspReference:
+ description: Adyen's 16-character reference associated with the transaction/request.
+ This value is globally unique; quote it when communicating with us about
+ this request.
+ type: string
+ refusalReason:
+ description: 'If the payment''s authorisation is refused or an error occurs
+ during authorisation, this field holds Adyen''s mapped reason for the
+ refusal or a description of the error. When a transaction fails, the authorisation
+ response includes `resultCode` and `refusalReason` values.
+
+
+ For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
+ type: string
+ resultCode:
+ description: "The result of the cancellation request.\n\nPossible values:\n\
+ \n* **Success** \u2013 Indicates that the balance check was successful.\n\
+ * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\
+ \ have enough balance to pay the amount in the request, or that the currency\
+ \ of the balance on the card did not match the currency of the requested\
+ \ amount.\n* **Failed** \u2013 Indicates that the balance check failed."
+ enum:
+ - Success
+ - NotEnoughBalance
+ - Failed
+ type: string
+ transactionLimit:
+ x-addedInVersion: '65'
+ description: The maximum spendable balance for a single transaction. Applicable
+ to some gift cards.
+ $ref: '#/components/schemas/Amount'
+ required:
+ - balance
+ - resultCode
+ type: object
+ BankAccount:
+ properties:
+ bankAccountNumber:
+ description: The bank account number (without separators).
+ type: string
+ bankCity:
+ x-addedInVersion: '18'
+ description: The bank city.
+ type: string
+ bankLocationId:
+ description: The location id of the bank. The field value is `nil` in most
+ cases.
+ type: string
+ bankName:
+ description: The name of the bank.
+ type: string
+ bic:
+ description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362)
+ (BIC) is the SWIFT address assigned to a bank. The field value is `nil`
+ in most cases.
+ type: string
+ countryCode:
+ description: 'Country code where the bank is located.
+
+
+ A valid value is an ISO two-character country code (e.g. ''NL'').'
+ type: string
+ iban:
+ description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number)
+ (IBAN).
+ type: string
+ ownerName:
+ description: "The name of the bank account holder.\nIf you submit a name\
+ \ with non-Latin characters, we automatically replace some of them with\
+ \ corresponding Latin characters to meet the FATF recommendations. For\
+ \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\
+ \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\
+ \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\
+ \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\
+ \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\
+ \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\
+ > If provided details don't match the required format, the response returns\
+ \ the error message: 203 'Invalid bank account holder name'."
+ type: string
+ taxId:
+ x-addedInVersion: '18'
+ description: The bank account holder's tax ID.
+ type: string
+ type: object
+ BillDeskDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The issuer id of the shopper's selected bank.
+ type: string
+ type:
+ description: '**billdesk**'
+ enum:
+ - billdesk_online
+ - billdesk_wallet
+ type: string
+ required:
+ - type
+ - issuer
+ title: BillDesk
+ type: object
+ BillingAddress:
+ properties:
+ city:
+ description: 'The name of the city. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ country:
+ description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
+ **US**.
+
+ > If you don''t know the country or are not collecting the country from
+ the shopper, provide `country` as `ZZ`.'
+ type: string
+ houseNumberOrName:
+ description: 'The number or name of the house. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ postalCode:
+ description: A maximum of five digits for an address in the US, or a maximum
+ of ten characters for an address in all other countries.
+ type: string
+ stateOrProvince:
+ description: 'The two-character ISO 3166-2 state or province code. For example,
+ **CA** in the US or **ON** in Canada.
+
+ > Required for the US and Canada.'
+ type: string
+ street:
+ description: 'The name of the street. Maximum length: 3000 characters.
+
+ > The house number should not be included in this field; it should be
+ separately provided via `houseNumberOrName`.'
+ maxLength: 3000
+ type: string
+ required:
+ - street
+ - houseNumberOrName
+ - city
+ - postalCode
+ - country
+ type: object
+ BlikDetails:
+ additionalProperties: false
+ properties:
+ blikCode:
+ description: BLIK code consisting of 6 digits.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ description: '**blik**'
+ enum:
+ - blik
+ type: string
+ title: BLIK
+ type: object
+ BrowserInfo:
+ properties:
+ acceptHeader:
+ description: The accept header value of the shopper's browser.
+ type: string
+ colorDepth:
+ x-addedInVersion: '40'
+ description: 'The color depth of the shopper''s browser in bits per pixel.
+ This should be obtained by using the browser''s `screen.colorDepth` property.
+ Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.'
+ format: int32
+ type: integer
+ javaEnabled:
+ x-addedInVersion: '40'
+ description: Boolean value indicating if the shopper's browser is able to
+ execute Java.
+ type: boolean
+ javaScriptEnabled:
+ x-addedInVersion: '40'
+ default: true
+ description: Boolean value indicating if the shopper's browser is able to
+ execute JavaScript. A default 'true' value is assumed if the field is
+ not present.
+ type: boolean
+ language:
+ x-addedInVersion: '40'
+ description: The `navigator.language` value of the shopper's browser (as
+ defined in IETF BCP 47).
+ type: string
+ screenHeight:
+ x-addedInVersion: '40'
+ description: The total height of the shopper's device screen in pixels.
+ format: int32
+ type: integer
+ screenWidth:
+ x-addedInVersion: '40'
+ description: The total width of the shopper's device screen in pixels.
+ format: int32
+ type: integer
+ timeZoneOffset:
+ x-addedInVersion: '40'
+ description: Time difference between UTC time and the shopper's browser
+ local time, in minutes.
+ format: int32
+ type: integer
+ userAgent:
+ description: The user agent value of the shopper's browser.
+ type: string
+ required:
+ - userAgent
+ - acceptHeader
+ - javaEnabled
+ - colorDepth
+ - screenHeight
+ - screenWidth
+ - timeZoneOffset
+ - language
+ type: object
+ CancelOrderRequest:
+ properties:
+ merchantAccount:
+ description: The merchant account identifier that orderData belongs to.
+ type: string
+ order:
+ description: The order request object that contains a pspReference that
+ represents the order and the matching encrypted order data.
+ $ref: '#/components/schemas/EncryptedOrderData'
+ required:
+ - order
+ - merchantAccount
+ type: object
+ CancelOrderResponse:
+ properties:
+ pspReference:
+ description: A unique reference of the cancellation request.
+ type: string
+ resultCode:
+ description: "The result of the cancellation request.\n\nPossible values:\n\
+ \n* **Received** \u2013 Indicates the cancellation has successfully been\
+ \ received by Adyen, and will be processed."
+ enum:
+ - Received
+ type: string
+ required:
+ - pspReference
+ - resultCode
+ type: object
+ Card:
+ properties:
+ cvc:
+ description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\
+ \ (1-20 characters). Depending on the card brand, it is known also as:\n\
+ * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\
+ \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\
+ \ the CVC code is present in the encrypted data. You must never post the\
+ \ card details to the server.\n> This field must be always present in\
+ \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\
+ > When this value is returned in a response, it is always empty because\
+ \ it is not stored."
+ maxLength: 20
+ minLength: 1
+ type: string
+ expiryMonth:
+ description: 'The card expiry month.
+
+ Format: 2 digits, zero-padded for single digits. For example:
+
+ * 03 = March
+
+ * 11 = November'
+ maxLength: 2
+ minLength: 1
+ type: string
+ expiryYear:
+ description: 'The card expiry year.
+
+ Format: 4 digits. For example: 2020'
+ maxLength: 4
+ minLength: 4
+ type: string
+ holderName:
+ description: The name of the cardholder, as printed on the card.
+ maxLength: 50
+ minLength: 1
+ type: string
+ issueNumber:
+ description: The issue number of the card (for some UK debit cards only).
+ maxLength: 2
+ minLength: 1
+ type: string
+ number:
+ description: 'The card number (4-19 characters). Do not use any separators.
+
+ When this value is returned in a response, only the last 4 digits of the
+ card number are returned.'
+ maxLength: 19
+ minLength: 4
+ type: string
+ startMonth:
+ description: The month component of the start date (for some UK debit cards
+ only).
+ maxLength: 2
+ minLength: 1
+ type: string
+ startYear:
+ description: The year component of the start date (for some UK debit cards
+ only).
+ maxLength: 4
+ minLength: 4
+ type: string
+ type: object
+ CardBrandDetails:
+ properties:
+ supported:
+ description: Indicates if you support the card brand.
+ type: boolean
+ type:
+ description: The name of the card brand.
+ type: string
+ type: object
+ CardDetails:
+ additionalProperties: false
+ properties:
+ brand:
+ description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ cupsecureplus.smscode:
+ deprecated: true
+ type: string
+ cvc:
+ description: The card verification code. Only collect raw card data if you
+ are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ encryptedCardNumber:
+ description: The encrypted card number.
+ maxLength: 15000
+ type: string
+ encryptedExpiryMonth:
+ description: The encrypted card expiry month.
+ maxLength: 15000
+ type: string
+ encryptedExpiryYear:
+ description: The encrypted card expiry year.
+ maxLength: 15000
+ type: string
+ encryptedSecurityCode:
+ description: The encrypted card verification code.
+ maxLength: 15000
+ type: string
+ expiryMonth:
+ description: The card expiry month. Only collect raw card data if you are
+ [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ expiryYear:
+ description: The card expiry year. Only collect raw card data if you are
+ [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ holderName:
+ description: The name of the card holder.
+ type: string
+ networkPaymentReference:
+ description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference)
+ from the response to the first payment.
+ type: string
+ number:
+ description: The card number. Only collect raw card data if you are [fully
+ PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ shopperNotificationReference:
+ description: The `shopperNotificationReference` returned in the response
+ when you requested to notify the shopper. Used only for recurring payments
+ in India.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ threeDS2SdkVersion:
+ description: Required for mobile integrations. Version of the 3D Secure
+ 2 mobile SDK.
+ maxLength: 12
+ type: string
+ type:
+ default: scheme
+ description: Default payment method details. Common for scheme payment methods,
+ and for simple payment method details.
+ enum:
+ - bcmc
+ - scheme
+ - networkToken
+ - giftcard
+ - card
+ type: string
+ title: Card
+ type: object
+ CardDetailsRequest:
+ properties:
+ cardNumber:
+ description: "A minimum of the first 8 digits of the card number and a maximum\
+ \ of the full card number. 11 digits gives the best result. \n\nYou must\
+ \ be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide)\
+ \ to collect raw card data."
+ type: string
+ countryCode:
+ description: 'The shopper country.
+
+
+ Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+
+ Example: NL or DE'
+ type: string
+ encryptedCardNumber:
+ description: The encrypted card number.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ supportedBrands:
+ description: "The card brands you support. This is the [`brands`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods__resParam_paymentMethods-brands)\
+ \ array from your [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)\
+ \ response. \n\nIf not included, our API uses the ones configured for\
+ \ your merchant account and, if provided, the country code."
+ items:
+ type: string
+ type: array
+ required:
+ - cardNumber
+ - merchantAccount
+ type: object
+ CardDetailsResponse:
+ properties:
+ brands:
+ description: The list of brands identified for the card.
+ items:
+ $ref: '#/components/schemas/CardBrandDetails'
+ type: array
+ type: object
+ CardDonations:
+ additionalProperties: false
+ properties:
+ brand:
+ description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ cupsecureplus.smscode:
+ deprecated: true
+ type: string
+ cvc:
+ description: The card verification code. Only collect raw card data if you
+ are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ encryptedCardNumber:
+ description: The encrypted card number.
+ maxLength: 15000
+ type: string
+ encryptedExpiryMonth:
+ description: The encrypted card expiry month.
+ maxLength: 15000
+ type: string
+ encryptedExpiryYear:
+ description: The encrypted card expiry year.
+ maxLength: 15000
+ type: string
+ encryptedSecurityCode:
+ description: The encrypted card verification code.
+ maxLength: 15000
+ type: string
+ expiryMonth:
+ description: The card expiry month. Only collect raw card data if you are
+ [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ expiryYear:
+ description: The card expiry year. Only collect raw card data if you are
+ [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ holderName:
+ description: The name of the card holder.
+ type: string
+ networkPaymentReference:
+ description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference)
+ from the response to the first payment.
+ type: string
+ number:
+ description: The card number. Only collect raw card data if you are [fully
+ PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ shopperNotificationReference:
+ description: The `shopperNotificationReference` returned in the response
+ when you requested to notify the shopper. Used only for recurring payments
+ in India.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ threeDS2SdkVersion:
+ description: Required for mobile integrations. Version of the 3D Secure
+ 2 mobile SDK.
+ maxLength: 12
+ type: string
+ type:
+ default: scheme
+ description: Default payment method details. Common for scheme payment methods,
+ and for simple payment method details.
+ enum:
+ - bcmc
+ - scheme
+ - networkToken
+ - giftcard
+ - card
+ type: string
+ title: Card
+ type: object
+ CellulantDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The Cellulant issuer.
+ type: string
+ type:
+ default: cellulant
+ description: '**Cellulant**'
+ enum:
+ - cellulant
+ type: string
+ title: Cellulant
+ type: object
+ CheckoutAwaitAction:
+ additionalProperties: false
+ properties:
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ type:
+ description: '**await**'
+ enum:
+ - await
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutDelegatedAuthenticationAction:
+ additionalProperties: false
+ properties:
+ authorisationToken:
+ description: A token needed to authorise a payment.
+ type: string
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ token:
+ description: A token to pass to the delegatedAuthentication component.
+ type: string
+ type:
+ description: '**delegatedAuthentication**'
+ enum:
+ - delegatedAuthentication
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutNativeRedirectAction:
+ additionalProperties: false
+ properties:
+ data:
+ additionalProperties:
+ type: string
+ description: When the redirect URL must be accessed via POST, use this data
+ to post to the redirect URL.
+ type: object
+ method:
+ description: Specifies the HTTP method, for example GET or POST.
+ type: string
+ nativeRedirectData:
+ description: Native SDK's redirect data containing the direct issuer link
+ and state data that must be submitted to the /v1/nativeRedirect/redirectResult.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ type:
+ description: '**nativeRedirect**'
+ enum:
+ - nativeRedirect
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutOrderResponse:
+ properties:
+ amount:
+ description: The initial amount of the order.
+ $ref: '#/components/schemas/Amount'
+ expiresAt:
+ description: The expiry date for the order.
+ type: string
+ orderData:
+ description: The encrypted order data.
+ type: string
+ pspReference:
+ description: The `pspReference` that belongs to the order.
+ type: string
+ reference:
+ description: The merchant reference for the order.
+ type: string
+ remainingAmount:
+ description: The updated remaining amount.
+ $ref: '#/components/schemas/Amount'
+ required:
+ - pspReference
+ type: object
+ CheckoutQrCodeAction:
+ additionalProperties: false
+ properties:
+ expiresAt:
+ description: Expiry time of the QR code.
+ type: string
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ qrCodeData:
+ description: The contents of the QR code as a UTF8 string.
+ type: string
+ type:
+ description: '**qrCode**'
+ enum:
+ - qrCode
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutRedirectAction:
+ additionalProperties: false
+ properties:
+ data:
+ additionalProperties:
+ type: string
+ description: When the redirect URL must be accessed via POST, use this data
+ to post to the redirect URL.
+ type: object
+ method:
+ description: Specifies the HTTP method, for example GET or POST.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ type:
+ description: '**redirect**'
+ enum:
+ - redirect
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutSDKAction:
+ additionalProperties: false
+ properties:
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ sdkData:
+ additionalProperties:
+ type: string
+ description: The data to pass to the SDK.
+ type: object
+ type:
+ description: The type of the action.
+ enum:
+ - sdk
+ - wechatpaySDK
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutSessionInstallmentOption:
+ properties:
+ plans:
+ description: 'Defines the type of installment plan. If not set, defaults
+ to **regular**.
+
+
+ Possible values:
+
+ * **regular**
+
+ * **revolving**'
+ items:
+ enum:
+ - regular
+ - revolving
+ type: string
+ type: array
+ preselectedValue:
+ description: Preselected number of installments offered for this payment
+ method.
+ format: int32
+ type: integer
+ values:
+ description: An array of the number of installments that the shopper can
+ choose from. For example, **[2,3,5]**. This cannot be specified simultaneously
+ with `maxValue`.
+ items:
+ format: int32
+ type: integer
+ type: array
+ type: object
+ CheckoutThreeDS2Action:
+ additionalProperties: false
+ properties:
+ authorisationToken:
+ description: A token needed to authorise a payment.
+ type: string
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ subtype:
+ description: A subtype of the token.
+ type: string
+ token:
+ description: A token to pass to the 3DS2 Component to get the fingerprint.
+ type: string
+ type:
+ description: '**threeDS2**'
+ enum:
+ - threeDS2
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CheckoutVoucherAction:
+ additionalProperties: false
+ properties:
+ alternativeReference:
+ description: The voucher alternative reference code.
+ type: string
+ collectionInstitutionNumber:
+ description: A collection institution number (store number) for Econtext
+ Pay-Easy ATM.
+ type: string
+ downloadUrl:
+ description: The URL to download the voucher.
+ type: string
+ entity:
+ description: An entity number of Multibanco.
+ type: string
+ expiresAt:
+ description: The date time of the voucher expiry.
+ type: string
+ initialAmount:
+ description: The initial amount.
+ $ref: '#/components/schemas/Amount'
+ instructionsUrl:
+ description: The URL to the detailed instructions to make payment using
+ the voucher.
+ type: string
+ issuer:
+ description: The issuer of the voucher.
+ type: string
+ maskedTelephoneNumber:
+ description: The shopper telephone number (partially masked).
+ type: string
+ merchantName:
+ description: The merchant name.
+ type: string
+ merchantReference:
+ description: The merchant reference.
+ type: string
+ passCreationToken:
+ x-addedInVersion: '68'
+ description: A base64 encoded signature of all properties
+ type: string
+ paymentData:
+ description: Encoded payment data.
+ type: string
+ paymentMethodType:
+ description: Specifies the payment method.
+ type: string
+ reference:
+ description: The voucher reference code.
+ type: string
+ shopperEmail:
+ description: The shopper email.
+ type: string
+ shopperName:
+ description: The shopper name.
+ type: string
+ surcharge:
+ description: The surcharge amount.
+ $ref: '#/components/schemas/Amount'
+ totalAmount:
+ description: The total amount (initial plus surcharge amount).
+ $ref: '#/components/schemas/Amount'
+ type:
+ description: '**voucher**'
+ enum:
+ - voucher
+ type: string
+ url:
+ description: Specifies the URL to redirect to.
+ type: string
+ required:
+ - type
+ type: object
+ CommonField:
+ properties:
+ name:
+ description: Name of the field. For example, Name of External Platform.
+ type: string
+ version:
+ description: Version of the field. For example, Version of External Platform.
+ type: string
+ type: object
+ Company:
+ properties:
+ homepage:
+ description: The company website's home page.
+ type: string
+ name:
+ description: The company name.
+ type: string
+ registrationNumber:
+ description: Registration number of the company.
+ type: string
+ registryLocation:
+ description: Registry location of the company.
+ type: string
+ taxId:
+ description: Tax ID of the company.
+ type: string
+ type:
+ description: The company type.
+ type: string
+ type: object
+ Configuration:
+ properties:
+ avs:
+ description: Describes the configuration for AVS ([Address Verification
+ System](https://en.wikipedia.org/wiki/Address_Verification_System)).
+ $ref: '#/components/schemas/Avs'
+ cardHolderName:
+ x-addedInVersion: '37'
+ description: 'Determines whether the cardholder name should be provided
+ or not.
+
+
+ Permitted values:
+
+ * NONE
+
+ * OPTIONAL
+
+ * REQUIRED'
+ enum:
+ - NONE
+ - OPTIONAL
+ - REQUIRED
+ type: string
+ installments:
+ description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
+ $ref: '#/components/schemas/InstallmentsNumber'
+ shopperInput:
+ x-addedInVersion: '37'
+ description: Determines how to display the details fields.
+ $ref: '#/components/schemas/ShopperInput'
+ type: object
+ CreateCheckoutSessionRequest:
+ properties:
+ accountInfo:
+ description: 'Shopper account information for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/AccountInfo'
+ additionalAmount:
+ description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ request to use a non-zero value, assign this value to `additionalAmount`
+ (while the amount must be still set to 0 to trigger BIN or card verification).
+
+ Required to be in the same currency as the `amount`. '
+ $ref: '#/components/schemas/Amount'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ allowedPaymentMethods:
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The amount of the payment.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ authenticationData:
+ x-addedInVersion: '69'
+ description: Configuration data for 3DS payments.
+ $ref: '#/components/schemas/AuthenticationData'
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/BillingAddress'
+ blockedPaymentMethods:
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ captureDelayHours:
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field is optional for filtering out payment methods that are only available
+ on specific platforms. If this value is not set, then we will try to infer
+ it from the `sdkVersion` or `token`.
+
+
+ Possible values:
+
+ * **iOS**
+
+ * **Android**
+
+ * **Web**'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ company:
+ description: Information regarding the company.
+ $ref: '#/components/schemas/Company'
+ countryCode:
+ description: The shopper's two-letter country code.
+ type: string
+ dateOfBirth:
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date
+ type: string
+ deliverAt:
+ description: 'The date and time when the purchased goods should be delivered.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
+ for example, **2020-12-18T10:15:30+01:00**.'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/DeliveryAddress'
+ enableOneClick:
+ description: When true and `shopperReference` is provided, the shopper will
+ be asked if the payment details should be stored for future one-click
+ payments.
+ type: boolean
+ enablePayOut:
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for payouts.
+ type: boolean
+ enableRecurring:
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for recurring payments.
+ type: boolean
+ expiresAt:
+ description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
+ format. When not specified, the expiry date is set to 1 hour after session
+ creation. You cannot set the session expiry to more than 24 hours after
+ session creation.
+ format: date-time
+ type: string
+ fundOrigin:
+ description: The person or entity funding the money.
+ $ref: '#/components/schemas/FundOrigin'
+ fundRecipient:
+ description: the person or entity receiving the money
+ $ref: '#/components/schemas/FundRecipient'
+ installmentOptions:
+ additionalProperties:
+ $ref: '#/components/schemas/CheckoutSessionInstallmentOption'
+ description: A set of key-value pairs that specifies the installment options
+ available per payment method. The key must be a payment method name in
+ lowercase. For example, **card** to specify installment options for all
+ cards, or **visa** or **mc**. The value must be an object containing the
+ installment options.
+ type: object
+ lineItems:
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
+ Ratepay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ mandate:
+ description: The mandate details to initiate recurring transaction.
+ $ref: '#/components/schemas/Mandate'
+ mcc:
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantOrderReference:
+ description: 'This reference allows linking multiple transactions to each
+ other for reporting purposes (i.e. order auth-rate). The reference should
+ be unique per billing cycle.
+
+ The same merchant order reference should never be reused after the first
+ authorised attempt. If used, this field should be supplied for all incoming
+ authorisations.
+
+ > We strongly recommend you send the `merchantOrderReference` value to
+ benefit from linking payment requests when authorisation retries take
+ place. In addition, we recommend you provide `retry.orderAttemptNumber`,
+ `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
+ type: string
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request.
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ mode:
+ x-addedInVersion: '69'
+ default: embedded
+ description: 'Indicates the type of front end integration. Possible values:
+
+ * **embedded** (default): Drop-in or Components integration
+
+ * **hosted**: Hosted Checkout integration'
+ enum:
+ - embedded
+ - hosted
+ type: string
+ mpiData:
+ description: Authentication data produced by an MPI (Mastercard SecureCode,
+ Visa Secure, or Cartes Bancaires).
+ $ref: '#/components/schemas/ThreeDSecureData'
+ platformChargebackLogic:
+ x-addedInVersion: '70'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ recurringExpiry:
+ description: Date after which no further authorisations shall be performed.
+ Only for 3D Secure 2.
+ type: string
+ recurringFrequency:
+ description: Minimum number of days between authorisations. Only for 3D
+ Secure 2.
+ type: string
+ recurringProcessingModel:
+ description: "Defines a recurring payment type. Required when creating a\
+ \ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\
+ \ A transaction for a fixed or variable amount, which follows a fixed\
+ \ schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
+ \ card details are stored to enable one-click or omnichannel journeys,\
+ \ or simply to streamline the checkout process. Any subscription not following\
+ \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
+ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
+ \ that occurs on a non-fixed schedule and/or have variable amounts. For\
+ \ example, automatic top-ups when a cardholder's balance drops below a\
+ \ certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ redirectFromIssuerMethod:
+ description: Specifies the redirect method (GET or POST) when redirecting
+ back from the issuer.
+ type: string
+ redirectToIssuerMethod:
+ description: Specifies the redirect method (GET or POST) when redirecting
+ to the issuer.
+ type: string
+ reference:
+ description: The reference to uniquely identify a payment.
+ type: string
+ returnUrl:
+ description: The URL to return to when a redirect payment is completed.
+ type: string
+ riskData:
+ description: Any risk-related settings to apply to the payment.
+ $ref: '#/components/schemas/RiskData'
+ shopperEmail:
+ description: The shopper's email address.
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ description: The shopper's full name. This object is required for some payment
+ methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
+ Seller Protection program.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ maxLength: 256
+ minLength: 3
+ type: string
+ shopperStatement:
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ showInstallmentAmount:
+ description: Set to true to show the payment amount per installment.
+ type: boolean
+ showRemovePaymentMethodButton:
+ description: Set to **true** to show a button that lets the shopper remove
+ a stored payment method.
+ type: boolean
+ socialSecurityNumber:
+ description: The shopper's social security number.
+ type: string
+ splitCardFundingSources:
+ default: false
+ description: Boolean value indicating whether the card payment method should
+ be split into separate debit and credit options.
+ type: boolean
+ splits:
+ description: An array of objects specifying how to split a payment when
+ using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information),
+ [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information),
+ or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ type: string
+ storePaymentMethod:
+ description: When this is set to **true** and the `shopperReference` is
+ provided, the payment details will be stored.
+ type: boolean
+ storePaymentMethodMode:
+ x-addedInVersion: '70'
+ description: "Indicates if the details of the payment method will be stored\
+ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\
+ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
+ \ is provided, the UI lets the shopper choose if they want their payment\
+ \ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
+ \ is provided, the details will be stored without asking the shopper for\
+ \ consent."
+ enum:
+ - askForConsent
+ - disabled
+ - enabled
+ type: string
+ telephoneNumber:
+ description: The shopper's telephone number.
+ type: string
+ themeId:
+ x-addedInVersion: '69'
+ description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout).
+ The value can be any of the **Theme ID** values from your Customer Area.
+ type: string
+ threeDSAuthenticationOnly:
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ trustedShopper:
+ description: Set to true if the payment should be routed to a trusted MID.
+ type: boolean
+ required:
+ - amount
+ - reference
+ - returnUrl
+ - merchantAccount
+ type: object
+ CreateCheckoutSessionResponse:
+ properties:
+ accountInfo:
+ description: 'Shopper account information for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/AccountInfo'
+ additionalAmount:
+ description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ request to use a non-zero value, assign this value to `additionalAmount`
+ (while the amount must be still set to 0 to trigger BIN or card verification).
+
+ Required to be in the same currency as the `amount`. '
+ $ref: '#/components/schemas/Amount'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ allowedPaymentMethods:
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The amount of the payment.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ authenticationData:
+ x-addedInVersion: '69'
+ description: Configuration data for 3DS payments.
+ $ref: '#/components/schemas/AuthenticationData'
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/BillingAddress'
+ blockedPaymentMethods:
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ captureDelayHours:
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field is optional for filtering out payment methods that are only available
+ on specific platforms. If this value is not set, then we will try to infer
+ it from the `sdkVersion` or `token`.
+
+
+ Possible values:
+
+ * **iOS**
+
+ * **Android**
+
+ * **Web**'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ company:
+ description: Information regarding the company.
+ $ref: '#/components/schemas/Company'
+ countryCode:
+ description: The shopper's two-letter country code.
+ type: string
+ dateOfBirth:
+ description: The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
+ format.
+ format: date-time
+ type: string
+ deliverAt:
+ description: 'The date and time when the purchased goods should be delivered.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
+ for example, **2020-12-18T10:15:30+01:00**.'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/DeliveryAddress'
+ enableOneClick:
+ description: When true and `shopperReference` is provided, the shopper will
+ be asked if the payment details should be stored for future one-click
+ payments.
+ type: boolean
+ enablePayOut:
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for payouts.
+ type: boolean
+ enableRecurring:
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for recurring payments.
+ type: boolean
+ expiresAt:
+ description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)
+ format. When not specified, the expiry date is set to 1 hour after session
+ creation. You cannot set the session expiry to more than 24 hours after
+ session creation.
+ format: date-time
+ type: string
+ fundOrigin:
+ description: The person or entity funding the money.
+ $ref: '#/components/schemas/FundOrigin'
+ fundRecipient:
+ description: the person or entity receiving the money
+ $ref: '#/components/schemas/FundRecipient'
+ id:
+ description: A unique identifier of the session.
+ readOnly: true
+ type: string
+ installmentOptions:
+ additionalProperties:
+ $ref: '#/components/schemas/CheckoutSessionInstallmentOption'
+ description: A set of key-value pairs that specifies the installment options
+ available per payment method. The key must be a payment method name in
+ lowercase. For example, **card** to specify installment options for all
+ cards, or **visa** or **mc**. The value must be an object containing the
+ installment options.
+ type: object
+ lineItems:
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
+ Ratepay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ mandate:
+ description: The mandate details to initiate recurring transaction.
+ $ref: '#/components/schemas/Mandate'
+ mcc:
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantOrderReference:
+ description: 'This reference allows linking multiple transactions to each
+ other for reporting purposes (i.e. order auth-rate). The reference should
+ be unique per billing cycle.
+
+ The same merchant order reference should never be reused after the first
+ authorised attempt. If used, this field should be supplied for all incoming
+ authorisations.
+
+ > We strongly recommend you send the `merchantOrderReference` value to
+ benefit from linking payment requests when authorisation retries take
+ place. In addition, we recommend you provide `retry.orderAttemptNumber`,
+ `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
+ type: string
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request.
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ mode:
+ x-addedInVersion: '70'
+ default: embedded
+ description: 'Indicates the type of front end integration. Possible values:
+
+ * **embedded** (default): Drop-in or Components integration
+
+ * **hosted**: Hosted Checkout integration'
+ enum:
+ - embedded
+ - hosted
+ type: string
+ mpiData:
+ description: Authentication data produced by an MPI (Mastercard SecureCode,
+ Visa Secure, or Cartes Bancaires).
+ $ref: '#/components/schemas/ThreeDSecureData'
+ platformChargebackLogic:
+ x-addedInVersion: '70'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ recurringExpiry:
+ description: Date after which no further authorisations shall be performed.
+ Only for 3D Secure 2.
+ type: string
+ recurringFrequency:
+ description: Minimum number of days between authorisations. Only for 3D
+ Secure 2.
+ type: string
+ recurringProcessingModel:
+ description: "Defines a recurring payment type. Required when creating a\
+ \ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\
+ \ A transaction for a fixed or variable amount, which follows a fixed\
+ \ schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
+ \ card details are stored to enable one-click or omnichannel journeys,\
+ \ or simply to streamline the checkout process. Any subscription not following\
+ \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
+ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
+ \ that occurs on a non-fixed schedule and/or have variable amounts. For\
+ \ example, automatic top-ups when a cardholder's balance drops below a\
+ \ certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ redirectFromIssuerMethod:
+ description: Specifies the redirect method (GET or POST) when redirecting
+ back from the issuer.
+ type: string
+ redirectToIssuerMethod:
+ description: Specifies the redirect method (GET or POST) when redirecting
+ to the issuer.
+ type: string
+ reference:
+ description: The reference to uniquely identify a payment.
+ type: string
+ returnUrl:
+ description: The URL to return to when a redirect payment is completed.
+ type: string
+ riskData:
+ description: Any risk-related settings to apply to the payment.
+ $ref: '#/components/schemas/RiskData'
+ sessionData:
+ description: The payment session data you need to pass to your front end.
+ type: string
+ shopperEmail:
+ description: The shopper's email address.
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ description: The shopper's full name. This object is required for some payment
+ methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
+ Seller Protection program.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ maxLength: 256
+ minLength: 3
+ type: string
+ shopperStatement:
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ showInstallmentAmount:
+ description: Set to true to show the payment amount per installment.
+ type: boolean
+ showRemovePaymentMethodButton:
+ description: Set to **true** to show a button that lets the shopper remove
+ a stored payment method.
+ type: boolean
+ socialSecurityNumber:
+ description: The shopper's social security number.
+ type: string
+ splitCardFundingSources:
+ default: false
+ description: Boolean value indicating whether the card payment method should
+ be split into separate debit and credit options.
+ type: boolean
+ splits:
+ description: An array of objects specifying how to split a payment when
+ using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information),
+ [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information),
+ or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ type: string
+ storePaymentMethod:
+ description: When this is set to **true** and the `shopperReference` is
+ provided, the payment details will be stored.
+ type: boolean
+ storePaymentMethodMode:
+ x-addedInVersion: '70'
+ description: "Indicates if the details of the payment method will be stored\
+ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\
+ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
+ \ is provided, the UI lets the shopper choose if they want their payment\
+ \ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
+ \ is provided, the details will be stored without asking the shopper for\
+ \ consent."
+ enum:
+ - askForConsent
+ - disabled
+ - enabled
+ type: string
+ telephoneNumber:
+ description: The shopper's telephone number.
+ type: string
+ themeId:
+ x-addedInVersion: '69'
+ description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout).
+ The value can be any of the **Theme ID** values from your Customer Area.
+ type: string
+ threeDSAuthenticationOnly:
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ trustedShopper:
+ description: Set to true if the payment should be routed to a trusted MID.
+ type: boolean
+ url:
+ x-addedInVersion: '69'
+ description: The URL for the Hosted Checkout page. Redirect the shopper
+ to this URL so they can make the payment.
+ type: string
+ required:
+ - id
+ - amount
+ - reference
+ - returnUrl
+ - expiresAt
+ - merchantAccount
+ type: object
+ CreateOrderRequest:
+ properties:
+ amount:
+ description: The total amount of the order.
+ $ref: '#/components/schemas/Amount'
+ expiresAt:
+ description: The date that order expires; e.g. 2019-03-23T12:25:28Z. If
+ not provided, the default expiry duration is 1 day.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the order.
+ type: string
+ reference:
+ description: A custom reference identifying the order.
+ type: string
+ required:
+ - merchantAccount
+ - reference
+ - amount
+ type: object
+ CreateOrderResponse:
+ properties:
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
+ - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCard'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
+ - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
+ - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
+ - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
+ - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
+ - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
+ description: 'Contains additional information about the payment. Some data
+ fields are included only if you select them first: Go to **Customer Area**
+ > **Developers** > **Additional data**.'
+ type: object
+ amount:
+ x-addedInVersion: '68'
+ description: The initial amount of the order.
+ $ref: '#/components/schemas/Amount'
+ expiresAt:
+ description: The date that the order will expire.
+ type: string
+ fraudResult:
+ description: The fraud result properties of the payment.
+ $ref: '#/components/schemas/FraudResult'
+ orderData:
+ description: The encrypted data that will be used by merchant for adding
+ payments to the order.
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the transaction/request.
+ This value is globally unique; quote it when communicating with us about
+ this request.
+ type: string
+ reference:
+ description: The reference provided by merchant for creating the order.
+ type: string
+ refusalReason:
+ description: 'If the payment''s authorisation is refused or an error occurs
+ during authorisation, this field holds Adyen''s mapped reason for the
+ refusal or a description of the error. When a transaction fails, the authorisation
+ response includes `resultCode` and `refusalReason` values.
+
+
+ For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
+ type: string
+ remainingAmount:
+ description: The remaining amount in the order.
+ $ref: '#/components/schemas/Amount'
+ resultCode:
+ description: "The result of the order creation request.\n The value is always\
+ \ **Success**."
+ enum:
+ - Success
+ type: string
+ required:
+ - amount
+ - remainingAmount
+ - expiresAt
+ - orderData
+ - resultCode
+ type: object
+ DeliveryAddress:
+ properties:
+ city:
+ description: 'The name of the city. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ country:
+ description: 'The two-character ISO-3166-1 alpha-2 country code. For example,
+ **US**.
+
+ > If you don''t know the country or are not collecting the country from
+ the shopper, provide `country` as `ZZ`.'
+ type: string
+ firstName:
+ type: string
+ houseNumberOrName:
+ description: 'The number or name of the house. Maximum length: 3000 characters.'
+ maxLength: 3000
+ type: string
+ lastName:
+ type: string
+ postalCode:
+ description: A maximum of five digits for an address in the US, or a maximum
+ of ten characters for an address in all other countries.
+ type: string
+ stateOrProvince:
+ description: 'The two-character ISO 3166-2 state or province code. For example,
+ **CA** in the US or **ON** in Canada.
+
+ > Required for the US and Canada.'
+ type: string
+ street:
+ description: 'The name of the street. Maximum length: 3000 characters.
+
+ > The house number should not be included in this field; it should be
+ separately provided via `houseNumberOrName`.'
+ maxLength: 3000
+ type: string
+ required:
+ - street
+ - houseNumberOrName
+ - city
+ - postalCode
+ - country
+ type: object
+ DetailsRequestAuthenticationData:
+ properties:
+ authenticationOnly:
+ x-addedInVersion: '69'
+ default: false
+ description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+
+ Default: *false**.'
+ type: boolean
+ type: object
+ DeviceRenderOptions:
+ properties:
+ sdkInterface:
+ default: both
+ description: 'Supported SDK interface types.
+
+ Allowed values:
+
+ * native
+
+ * html
+
+ * both'
+ enum:
+ - native
+ - html
+ - both
+ type: string
+ sdkUiType:
+ description: 'UI types supported for displaying specific challenges.
+
+ Allowed values:
+
+ * text
+
+ * singleSelect
+
+ * outOfBand
+
+ * otherHtml
+
+ * multiSelect'
+ items:
+ enum:
+ - multiSelect
+ - otherHtml
+ - outOfBand
+ - singleSelect
+ - text
+ type: string
+ type: array
+ type: object
+ DokuDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ firstName:
+ description: The shopper's first name.
+ type: string
+ lastName:
+ description: The shopper's last name.
+ type: string
+ shopperEmail:
+ description: The shopper's email.
+ type: string
+ type:
+ description: '**doku**'
+ enum:
+ - doku_mandiri_va
+ - doku_cimb_va
+ - doku_danamon_va
+ - doku_bni_va
+ - doku_permata_lite_atm
+ - doku_bri_va
+ - doku_bca_va
+ - doku_alfamart
+ - doku_indomaret
+ - doku_wallet
+ - doku_ovo
+ type: string
+ required:
+ - type
+ - firstName
+ - lastName
+ - shopperEmail
+ title: Doku
+ type: object
+ DonationPaymentRequest:
+ properties:
+ accountInfo:
+ x-addedInVersion: '40'
+ description: 'Shopper account information for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/AccountInfo'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ amount:
+ description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
+ For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ requests, set amount to 0 (zero).
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ x-addedInVersion: '40'
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ authenticationData:
+ x-addedInVersion: '69'
+ description: Data for 3DS authentication.
+ $ref: '#/components/schemas/AuthenticationData'
+ billingAddress:
+ description: 'The address where to send the invoice.
+
+ > The `billingAddress` object is required in the following scenarios.
+ Include all of the fields within this object.
+
+ >* For 3D Secure 2 transactions in all browser-based and mobile implementations.
+
+ >* For cross-border payouts to and from Canada.'
+ $ref: '#/components/schemas/BillingAddress'
+ browserInfo:
+ description: 'The shopper''s browser information.
+
+ > For 3D Secure, the full object is required for web integrations. For
+ mobile app integrations, include the `userAgent` and `acceptHeader` fields
+ to indicate that your integration can support a redirect in case a payment
+ is routed to 3D Secure 1.'
+ $ref: '#/components/schemas/BrowserInfo'
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field is optional for filtering out payment methods that are only available
+ on specific platforms. If this value is not set, then we will try to infer
+ it from the `sdkVersion` or `token`.
+
+
+ Possible values:
+
+ * iOS
+
+ * Android
+
+ * Web'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: Checkout attempt ID that corresponds to the Id generated by
+ the client SDK for tracking user payment journey.
+ type: string
+ conversionId:
+ x-addedInVersion: '49'
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `checkoutAttemptId` instead
+ description: Conversion ID that corresponds to the Id generated by the client
+ SDK for tracking user payment journey.
+ type: string
+ countryCode:
+ description: 'The shopper country.
+
+
+ Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+
+ Example: NL or DE'
+ type: string
+ dateOfBirth:
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date-time
+ type: string
+ deliverAt:
+ x-addedInVersion: '70'
+ description: 'The date and time the purchased goods should be delivered.
+
+
+ Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
+
+
+ Example: 2017-07-17T13:42:40.428+01:00'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/DeliveryAddress'
+ deviceFingerprint:
+ description: A string containing the shopper's device fingerprint. For more
+ information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
+ maxLength: 5000
+ type: string
+ donationAccount:
+ description: Donation account to which the transaction is credited.
+ type: string
+ donationOriginalPspReference:
+ description: PSP reference of the transaction from which the donation token
+ is generated. Required when `donationToken` is provided.
+ type: string
+ donationToken:
+ description: Donation token received in the `/payments` call.
+ type: string
+ lineItems:
+ x-addedInVersion: '32'
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
+ Ratepay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantRiskIndicator:
+ x-addedInVersion: '40'
+ description: 'Additional risk fields for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/MerchantRiskIndicator'
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request. When exceeding, the "177" error
+ occurs: "Metadata size exceeds limit".
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ mpiData:
+ description: Authentication data produced by an MPI (Mastercard SecureCode,
+ Visa Secure, or Cartes Bancaires).
+ $ref: '#/components/schemas/ThreeDSecureData'
+ origin:
+ x-addedInVersion: '40'
+ description: 'Required for the 3D Secure 2 `channel` **Web** integration.
+
+
+ Set this parameter to the origin URL of the page that you are loading
+ the 3D Secure Component from.'
+ maxLength: 80
+ type: string
+ paymentMethod:
+ description: The type and required details of a payment method to use.
+ oneOf:
+ - $ref: '#/components/schemas/ApplePayDonations'
+ - $ref: '#/components/schemas/CardDonations'
+ - $ref: '#/components/schemas/GooglePayDonations'
+ - $ref: '#/components/schemas/IdealDonations'
+ - $ref: '#/components/schemas/PayWithGoogleDonations'
+ recurringProcessingModel:
+ x-addedInVersion: '30'
+ description: "Defines a recurring payment type. Required when creating a\
+ \ token to store payment details or using stored payment details.\nAllowed\
+ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
+ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
+ \ a card-on-file (CoF) transaction, card details are stored to enable\
+ \ one-click or omnichannel journeys, or simply to streamline the checkout\
+ \ process. Any subscription not following a fixed schedule is also considered\
+ \ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
+ \ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
+ \ schedule and/or have variable amounts. For example, automatic top-ups\
+ \ when a cardholder's balance drops below a certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ redirectFromIssuerMethod:
+ x-addedInVersion: '32'
+ description: Specifies the redirect method (GET or POST) when redirecting
+ back from the issuer.
+ type: string
+ redirectToIssuerMethod:
+ x-addedInVersion: '32'
+ description: Specifies the redirect method (GET or POST) when redirecting
+ to the issuer.
+ type: string
+ reference:
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement.
+
+ If you need to provide multiple references for a transaction, separate
+ them with hyphens ("-").
+
+ Maximum length: 80 characters.'
+ type: string
+ returnUrl:
+ description: 'The URL to return to in case of a redirection.
+
+ The format depends on the channel. This URL can have a maximum of 1024
+ characters.
+
+ * For web, include the protocol `http://` or `https://`. You can also
+ include your own additional query parameters, for example, shopper ID
+ or order reference number.
+
+ Example: `https://your-company.com/checkout?shopperOrder=12xy`
+
+ * For iOS, use the custom URL for your app. To know more about setting
+ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).
+
+ Example: `my-app://`
+
+ * For Android, use a custom URL handled by an Activity on your app. You
+ can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).
+
+ Example: `my-app://your.package.name`'
+ maxLength: 8000
+ type: string
+ sessionValidity:
+ description: 'The date and time until when the session remains valid, in
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
+
+
+ For example: 2020-07-18T15:42:40.428+01:00'
+ type: string
+ shopperEmail:
+ description: 'The shopper''s email address. We recommend that you provide
+ this data, as it is used in velocity fraud checks.
+
+ > For 3D Secure 2 transactions, schemes require `shopperEmail` for all
+ browser-based and mobile implementations.'
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ description: The shopper's full name.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ maxLength: 256
+ minLength: 3
+ type: string
+ socialSecurityNumber:
+ description: The shopper's social security number.
+ type: string
+ telephoneNumber:
+ description: The shopper's telephone number.
+ type: string
+ threeDS2RequestData:
+ x-addedInVersion: '40'
+ description: Request fields for 3D Secure 2. To check if any of the following
+ fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
+ or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
+ $ref: '#/components/schemas/ThreeDS2RequestFields'
+ threeDSAuthenticationOnly:
+ x-addedInVersion: '50'
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ required:
+ - paymentMethod
+ - returnUrl
+ - merchantAccount
+ - reference
+ - amount
+ type: object
+ DonationPaymentResponse:
+ properties:
+ amount:
+ description: Authorised amount in the transaction.
+ $ref: '#/components/schemas/Amount'
+ donationAccount:
+ description: The Adyen account name of your charity. We will provide you
+ with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding).
+ type: string
+ id:
+ description: Your unique resource identifier.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ payment:
+ description: Action to be taken for completing the payment.
+ $ref: '#/components/schemas/PaymentResponse'
+ reference:
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement. If
+ you need to provide multiple references for a transaction, separate them
+ with hyphens ("-"). Maximum length: 80 characters.'
+ type: string
+ status:
+ description: 'The status of the donation transaction.
+
+
+ Possible values:
+
+ * **completed**
+
+ * **pending**
+
+ * **refused**'
+ enum:
+ - completed
+ - pending
+ - refused
+ type: string
+ type: object
+ DotpayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The Dotpay issuer value of the shopper's selected bank. Set
+ this to an **id** of a Dotpay issuer to preselect it.
+ type: string
+ type:
+ default: dotpay
+ description: '**dotpay**'
+ enum:
+ - dotpay
+ type: string
+ required:
+ - issuer
+ title: Dotpay
+ type: object
+ DragonpayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The Dragonpay issuer value of the shopper's selected bank.
+ Set this to an **id** of a Dragonpay issuer to preselect it.
+ type: string
+ shopperEmail:
+ description: "The shopper\u2019s email address."
+ type: string
+ type:
+ description: '**dragonpay**'
+ enum:
+ - dragonpay_ebanking
+ - dragonpay_otc_banking
+ - dragonpay_otc_non_banking
+ - dragonpay_otc_philippines
+ type: string
+ required:
+ - type
+ - issuer
+ title: Dragonpay
+ type: object
+ EcontextVoucherDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ firstName:
+ description: The shopper's first name.
+ type: string
+ lastName:
+ description: The shopper's last name.
+ type: string
+ shopperEmail:
+ description: The shopper's email.
+ type: string
+ telephoneNumber:
+ description: The shopper's contact number. It must have an international
+ number format, for example **+31 20 779 1846**. Formats like **+31 (0)20
+ 779 1846** or **0031 20 779 1846** are not accepted.
+ type: string
+ type:
+ description: '**econtextvoucher**'
+ enum:
+ - econtext_seveneleven
+ - econtext_stores
+ type: string
+ required:
+ - type
+ - firstName
+ - lastName
+ - shopperEmail
+ - telephoneNumber
+ title: Voucher
+ type: object
+ EncryptedOrderData:
+ properties:
+ orderData:
+ description: The encrypted order data.
+ type: string
+ pspReference:
+ description: The `pspReference` that belongs to the order.
+ type: string
+ required:
+ - pspReference
+ - orderData
+ type: object
+ ExternalPlatform:
+ properties:
+ integrator:
+ description: External platform integrator.
+ type: string
+ name:
+ description: Name of the field. For example, Name of External Platform.
+ type: string
+ version:
+ description: Version of the field. For example, Version of External Platform.
+ type: string
+ type: object
+ ForexQuote:
+ properties:
+ account:
+ description: The account name.
+ type: string
+ accountType:
+ description: The account type.
+ type: string
+ baseAmount:
+ description: The base amount.
+ $ref: '#/components/schemas/Amount'
+ basePoints:
+ description: The base points.
+ format: int32
+ type: integer
+ buy:
+ description: The buy rate.
+ $ref: '#/components/schemas/Amount'
+ interbank:
+ description: The interbank amount.
+ $ref: '#/components/schemas/Amount'
+ reference:
+ description: The reference assigned to the forex quote request.
+ type: string
+ sell:
+ description: The sell rate.
+ $ref: '#/components/schemas/Amount'
+ signature:
+ description: The signature to validate the integrity.
+ type: string
+ source:
+ description: The source of the forex quote.
+ type: string
+ type:
+ description: The type of forex.
+ type: string
+ validTill:
+ description: The date until which the forex quote is valid.
+ format: date-time
+ type: string
+ required:
+ - validTill
+ - basePoints
+ type: object
+ FraudCheckResult:
+ properties:
+ accountScore:
+ description: The fraud score generated by the risk check.
+ format: int32
+ type: integer
+ checkId:
+ description: The ID of the risk check.
+ format: int32
+ type: integer
+ name:
+ description: The name of the risk check.
+ type: string
+ required:
+ - checkId
+ - name
+ - accountScore
+ type: object
+ FraudResult:
+ properties:
+ accountScore:
+ description: The total fraud score generated by the risk checks.
+ format: int32
+ type: integer
+ results:
+ description: The result of the individual risk checks.
+ items:
+ $ref: '#/components/schemas/FraudCheckResult'
+ type: array
+ required:
+ - accountScore
+ type: object
+ FundOrigin:
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/Address'
+ shopperEmail:
+ description: Email address of the person.
+ type: string
+ shopperName:
+ description: The name of the person
+ $ref: '#/components/schemas/Name'
+ telephoneNumber:
+ description: Phone number of the person
+ type: string
+ walletIdentifier:
+ type: string
+ type: object
+ FundRecipient:
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/Address'
+ paymentMethod:
+ description: the used paymentMetohd
+ $ref: '#/components/schemas/CardDetails'
+ shopperEmail:
+ description: the email address of the person
+ type: string
+ shopperName:
+ description: the name of the person
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ maxLength: 256
+ minLength: 3
+ type: string
+ storedPaymentMethodId:
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ subMerchant:
+ description: 'Required for Back-to-Back/ purchase driven load in Wallet
+ transactions.
+
+ Contains the final merchant who will be receiving the money, also known
+ as subMerchant, information.'
+ $ref: '#/components/schemas/SubMerchant'
+ telephoneNumber:
+ description: the telephone number of the person
+ type: string
+ walletIdentifier:
+ description: indicates where the money is going
+ type: string
+ walletOwnerTaxId:
+ description: indicates the tax identifier of the fund recepient
+ type: string
+ type: object
+ GenericIssuerPaymentMethodDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The issuer id of the shopper's selected bank.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ description: '**genericissuer**'
+ enum:
+ - onlineBanking_PL
+ - eps
+ - onlineBanking_SK
+ - onlineBanking_CZ
+ type: string
+ required:
+ - type
+ - issuer
+ title: Stored Payment Method
+ type: object
+ GiropayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: giropay
+ description: '**giropay**'
+ enum:
+ - giropay
+ type: string
+ title: Giropay
+ type: object
+ GooglePayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ googlePayCardNetwork:
+ description: 'The selected payment card network. '
+ type: string
+ googlePayToken:
+ description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
+ `PaymentData` response.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: googlepay
+ description: '**googlepay**, **paywithgoogle**'
+ enum:
+ - googlepay
+ type: string
+ required:
+ - googlePayToken
+ title: Google Pay
+ type: object
+ GooglePayDonations:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ googlePayCardNetwork:
+ description: 'The selected payment card network. '
+ type: string
+ googlePayToken:
+ description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
+ `PaymentData` response.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: googlepay
+ description: '**googlepay**, **paywithgoogle**'
+ enum:
+ - googlepay
+ type: string
+ required:
+ - googlePayToken
+ title: Google Pay
+ type: object
+ IdealDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The iDEAL issuer value of the shopper's selected bank. Set
+ this to an **id** of an iDEAL issuer to preselect it.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: ideal
+ description: '**ideal**'
+ enum:
+ - ideal
+ type: string
+ required:
+ - issuer
+ title: iDEAL
+ type: object
+ IdealDonations:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The iDEAL issuer value of the shopper's selected bank. Set
+ this to an **id** of an iDEAL issuer to preselect it.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: ideal
+ description: '**ideal**'
+ enum:
+ - ideal
+ type: string
+ required:
+ - issuer
+ title: iDEAL
+ type: object
+ InputDetail:
+ properties:
+ configuration:
+ additionalProperties:
+ type: string
+ description: Configuration parameters for the required input.
+ type: object
+ details:
+ description: Input details can also be provided recursively.
+ items:
+ $ref: '#/components/schemas/SubInputDetail'
+ type: array
+ inputDetails:
+ deprecated: true
+ description: Input details can also be provided recursively (deprecated).
+ items:
+ $ref: '#/components/schemas/SubInputDetail'
+ type: array
+ itemSearchUrl:
+ description: In case of a select, the URL from which to query the items.
+ type: string
+ items:
+ description: In case of a select, the items to choose from.
+ items:
+ $ref: '#/components/schemas/Item'
+ type: array
+ key:
+ description: The value to provide in the result.
+ type: string
+ optional:
+ description: True if this input value is optional.
+ type: boolean
+ type:
+ description: The type of the required input.
+ type: string
+ value:
+ description: The value can be pre-filled, if available.
+ type: string
+ type: object
+ InstallmentOption:
+ properties:
+ maxValue:
+ description: The maximum number of installments offered for this payment
+ method.
+ format: int32
+ type: integer
+ plans:
+ x-addedInVersion: '64'
+ description: 'Defines the type of installment plan. If not set, defaults
+ to **regular**.
+
+
+ Possible values:
+
+ * **regular**
+
+ * **revolving**'
+ items:
+ enum:
+ - regular
+ - revolving
+ type: string
+ type: array
+ preselectedValue:
+ x-addedInVersion: '64'
+ description: Preselected number of installments offered for this payment
+ method.
+ format: int32
+ type: integer
+ values:
+ x-addedInVersion: '64'
+ description: An array of the number of installments that the shopper can
+ choose from. For example, **[2,3,5]**. This cannot be specified simultaneously
+ with `maxValue`.
+ items:
+ format: int32
+ type: integer
+ type: array
+ type: object
+ Installments:
+ properties:
+ plan:
+ x-addedInVersion: '64'
+ description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan).
+ By default, this is set to **regular**. Possible values:
+
+ * **regular**
+
+ * **revolving**
+
+ '
+ enum:
+ - regular
+ - revolving
+ type: string
+ value:
+ description: 'Defines the number of installments. Its value needs to be
+ greater than zero.
+
+
+ Usually, the maximum allowed number of installments is capped. For example,
+ it may not be possible to split a payment in more than 24 installments.
+ The acquirer sets this upper limit, so its value may vary.'
+ format: int32
+ type: integer
+ required:
+ - value
+ type: object
+ InstallmentsNumber:
+ properties:
+ maxNumberOfInstallments:
+ description: Maximum number of installments
+ format: int32
+ type: integer
+ required:
+ - maxNumberOfInstallments
+ type: object
+ Item:
+ properties:
+ id:
+ description: The value to provide in the result.
+ type: string
+ name:
+ description: The display name.
+ type: string
+ type: object
+ KlarnaDetails:
+ additionalProperties: false
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ deliveryAddress:
+ description: The address where the goods should be delivered.
+ type: string
+ personalDetails:
+ description: Shopper name, date of birth, phone number, and email address.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ subtype:
+ description: The type of flow to initiate.
+ type: string
+ type:
+ default: klarna
+ description: '**klarna**'
+ enum:
+ - klarna
+ - klarnapayments
+ - klarnapayments_account
+ - klarnapayments_b2b
+ - klarna_paynow
+ - klarna_account
+ - klarna_b2b
+ type: string
+ required:
+ - type
+ title: Klarna
+ type: object
+ LineItem:
+ properties:
+ amountExcludingTax:
+ description: Item amount excluding the tax, in minor units.
+ format: int64
+ type: integer
+ amountIncludingTax:
+ description: Item amount including the tax, in minor units.
+ format: int64
+ type: integer
+ brand:
+ x-addedInVersion: '70'
+ description: Brand of the item.
+ type: string
+ color:
+ x-addedInVersion: '70'
+ description: Color of the item.
+ type: string
+ description:
+ description: Description of the line item.
+ type: string
+ id:
+ description: ID of the line item.
+ type: string
+ imageUrl:
+ description: Link to the picture of the purchased item.
+ type: string
+ itemCategory:
+ description: Item category, used by the payment methods PayPal and Ratepay.
+ type: string
+ manufacturer:
+ x-addedInVersion: '70'
+ description: Manufacturer of the item.
+ type: string
+ productUrl:
+ description: Link to the purchased item.
+ type: string
+ quantity:
+ description: Number of items.
+ format: int64
+ type: integer
+ receiverEmail:
+ x-addedInVersion: '70'
+ description: Email associated with the given product in the basket (usually
+ in electronic gift cards).
+ type: string
+ size:
+ x-addedInVersion: '70'
+ description: Size of the item.
+ type: string
+ sku:
+ x-addedInVersion: '70'
+ description: Stock keeping unit.
+ type: string
+ taxAmount:
+ description: Tax amount, in minor units.
+ format: int64
+ type: integer
+ taxPercentage:
+ description: Tax percentage, in minor units.
+ format: int64
+ type: integer
+ upc:
+ x-addedInVersion: '70'
+ description: Universal Product Code.
+ type: string
+ type: object
+ ListStoredPaymentMethodsResponse:
+ properties:
+ merchantAccount:
+ description: Your merchant account.
+ type: string
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ type: string
+ storedPaymentMethods:
+ description: List of all stored payment methods.
+ items:
+ $ref: '#/components/schemas/StoredPaymentMethodResource'
+ type: array
+ type: object
+ Mandate:
+ properties:
+ amount:
+ description: The billing amount (in minor units) of the recurring transactions.
+ type: string
+ amountRule:
+ description: "The limitation rule of the billing amount.\n\nPossible values:\n\
+ \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\
+ \ **exact**: The transaction amount should be the same as the `amount`.\n\
+ \n"
+ enum:
+ - max
+ - exact
+ type: string
+ billingAttemptsRule:
+ description: "The rule to specify the period, within which the recurring\
+ \ debit can happen, relative to the mandate recurring date.\n\nPossible\
+ \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\
+ \ and on a specific date.\n\n * **after**: On and after a specific date.\n\
+ \n"
+ enum:
+ - 'on'
+ - before
+ - after
+ type: string
+ billingDay:
+ description: 'The number of the day, on which the recurring debit can happen.
+ Should be within the same calendar month as the mandate recurring date.
+
+
+ Possible values: 1-31 based on the `frequency`.'
+ type: string
+ endsAt:
+ description: End date of the billing plan, in YYYY-MM-DD format.
+ type: string
+ frequency:
+ description: 'The frequency with which a shopper should be charged.
+
+
+ Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**,
+ **halfYearly**, **yearly**.'
+ enum:
+ - adhoc
+ - daily
+ - weekly
+ - biWeekly
+ - monthly
+ - quarterly
+ - halfYearly
+ - yearly
+ type: string
+ remarks:
+ description: The message shown by UPI to the shopper on the approval screen.
+ type: string
+ startsAt:
+ description: Start date of the billing plan, in YYYY-MM-DD format. By default,
+ the transaction date.
+ type: string
+ required:
+ - frequency
+ - amount
+ - endsAt
+ type: object
+ MasterpassDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ masterpassTransactionId:
+ description: The Masterpass transaction ID.
+ type: string
+ type:
+ default: masterpass
+ description: '**masterpass**'
+ enum:
+ - masterpass
+ type: string
+ required:
+ - masterpassTransactionId
+ title: Masterpass
+ type: object
+ MbwayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ shopperEmail:
+ description: ''
+ type: string
+ telephoneNumber:
+ description: ''
+ type: string
+ type:
+ default: mbway
+ description: '**mbway**'
+ enum:
+ - mbway
+ type: string
+ required:
+ - telephoneNumber
+ - shopperEmail
+ title: MBWay
+ type: object
+ MerchantDevice:
+ properties:
+ os:
+ description: Operating system running on the merchant device.
+ type: string
+ osVersion:
+ description: Version of the operating system on the merchant device.
+ type: string
+ reference:
+ description: Merchant device reference.
+ type: string
+ type: object
+ MerchantRiskIndicator:
+ properties:
+ addressMatch:
+ description: Whether the chosen delivery address is identical to the billing
+ address.
+ type: boolean
+ deliveryAddressIndicator:
+ description: 'Indicator regarding the delivery address.
+
+ Allowed values:
+
+ * `shipToBillingAddress`
+
+ * `shipToVerifiedAddress`
+
+ * `shipToNewAddress`
+
+ * `shipToStore`
+
+ * `digitalGoods`
+
+ * `goodsNotShipped`
+
+ * `other`'
+ enum:
+ - shipToBillingAddress
+ - shipToVerifiedAddress
+ - shipToNewAddress
+ - shipToStore
+ - digitalGoods
+ - goodsNotShipped
+ - other
+ type: string
+ deliveryEmail:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `deliveryEmailAddress` instead.
+ description: The delivery email address (for digital goods).
+ type: string
+ deliveryEmailAddress:
+ x-addedInVersion: '68'
+ description: 'For Electronic delivery, the email address to which the merchandise
+ was delivered. Maximum length: 254 characters.'
+ maxLength: 254
+ type: string
+ deliveryTimeframe:
+ description: 'The estimated delivery time for the shopper to receive the
+ goods.
+
+ Allowed values:
+
+ * `electronicDelivery`
+
+ * `sameDayShipping`
+
+ * `overnightShipping`
+
+ * `twoOrMoreDaysShipping`'
+ enum:
+ - electronicDelivery
+ - sameDayShipping
+ - overnightShipping
+ - twoOrMoreDaysShipping
+ type: string
+ giftCardAmount:
+ description: For prepaid or gift card purchase, the purchase amount total
+ of prepaid or gift card(s).
+ $ref: '#/components/schemas/Amount'
+ giftCardCount:
+ description: For prepaid or gift card purchase, total count of individual
+ prepaid or gift cards/codes purchased.
+ format: int32
+ type: integer
+ giftCardCurr:
+ x-addedInVersion: '68'
+ description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
+ three-digit currency code of the gift card, other than those listed in
+ Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.
+ type: string
+ preOrderDate:
+ description: For pre-order purchases, the expected date this product will
+ be available to the shopper.
+ format: date-time
+ type: string
+ preOrderPurchase:
+ description: Indicator for whether this transaction is for pre-ordering
+ a product.
+ type: boolean
+ preOrderPurchaseInd:
+ x-addedInVersion: '68'
+ description: Indicates whether Cardholder is placing an order for merchandise
+ with a future availability or release date.
+ type: string
+ reorderItems:
+ description: Indicator for whether the shopper has already purchased the
+ same items in the past.
+ type: boolean
+ reorderItemsInd:
+ x-addedInVersion: '68'
+ description: Indicates whether the cardholder is reordering previously purchased
+ merchandise.
+ type: string
+ shipIndicator:
+ x-addedInVersion: '68'
+ description: Indicates shipping method chosen for the transaction.
+ type: string
+ type: object
+ MobilePayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ type:
+ default: mobilepay
+ description: '**mobilepay**'
+ enum:
+ - mobilepay
+ type: string
+ title: MobilePay
+ type: object
+ MolPayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ issuer:
+ description: The shopper's bank. Specify this with the issuer value that
+ corresponds to this bank.
+ type: string
+ type:
+ description: '**molpay**'
+ enum:
+ - molpay_ebanking_fpx_MY
+ - molpay_ebanking_TH
+ type: string
+ required:
+ - type
+ - issuer
+ title: MOLPay
+ type: object
+ Name:
+ properties:
+ firstName:
+ description: The first name.
+ type: string
+ lastName:
+ description: The last name.
+ type: string
+ required:
+ - firstName
+ - lastName
+ type: object
+ OpenInvoiceDetails:
+ additionalProperties: false
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ deliveryAddress:
+ description: The address where the goods should be delivered.
+ type: string
+ personalDetails:
+ description: Shopper name, date of birth, phone number, and email address.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: openinvoice
+ description: '**openinvoice**'
+ enum:
+ - openinvoice
+ - afterpay_directdebit
+ - atome_pos
+ type: string
+ title: Open Invoice
+ type: object
+ PayPalDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ orderID:
+ description: The unique ID associated with the order.
+ type: string
+ payeePreferred:
+ description: IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED
+ type: string
+ payerID:
+ description: The unique ID associated with the payer.
+ type: string
+ payerSelected:
+ description: PAYPAL or PAYPAL_CREDIT
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ subtype:
+ description: The type of flow to initiate.
+ enum:
+ - redirect
+ - sdk
+ type: string
+ type:
+ default: paypal
+ description: '**paypal**'
+ enum:
+ - paypal
+ type: string
+ required:
+ - type
+ title: PayPal
+ type: object
+ PayUUpiDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ shopperNotificationReference:
+ description: The `shopperNotificationReference` returned in the response
+ when you requested to notify the shopper. Used for recurring payment only.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: payu_IN_upi
+ description: '**payu_IN_upi**'
+ enum:
+ - payu_IN_upi
+ type: string
+ virtualPaymentAddress:
+ description: The virtual payment address for UPI.
+ type: string
+ required:
+ - type
+ title: PayU
+ type: object
+ PayWithGoogleDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ googlePayToken:
+ description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
+ `PaymentData` response.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: paywithgoogle
+ description: '**paywithgoogle**'
+ enum:
+ - paywithgoogle
+ type: string
+ required:
+ - googlePayToken
+ title: Google Pay
+ type: object
+ PayWithGoogleDonations:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ googlePayToken:
+ description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData)
+ `PaymentData` response.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: paywithgoogle
+ description: '**paywithgoogle**'
+ enum:
+ - paywithgoogle
+ type: string
+ required:
+ - googlePayToken
+ title: Google Pay
+ type: object
+ PaymentAmountUpdateRequest:
+ properties:
+ amount:
+ description: The updated amount. The `currency` must match the currency
+ used in authorisation.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ industryUsage:
+ x-addedInVersion: '70'
+ description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
+ \ \n* **noShow** \n* **installment**"
+ enum:
+ - delayedCharge
+ - installment
+ - noShow
+ type: string
+ lineItems:
+ x-addedInVersion: '70'
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ reference:
+ description: 'Your reference for the amount update request. Maximum length:
+ 80 characters.'
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ required:
+ - merchantAccount
+ - amount
+ type: object
+ PaymentAmountUpdateResponse:
+ properties:
+ amount:
+ description: The updated amount.
+ $ref: '#/components/schemas/Amount'
+ industryUsage:
+ x-addedInVersion: '70'
+ description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
+ \ \n* **noShow** \n* **installment**"
+ enum:
+ - delayedCharge
+ - installment
+ - noShow
+ type: string
+ lineItems:
+ x-addedInVersion: '71'
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentPspReference:
+ description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment to update. '
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the amount update
+ request.
+ type: string
+ reference:
+ description: 'Your reference for the amount update request. Maximum length:
+ 80 characters.'
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ required:
+ - status
+ - merchantAccount
+ - amount
+ - reference
+ - pspReference
+ - paymentPspReference
+ type: object
+ PaymentCancelRequest:
+ properties:
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ reference:
+ description: 'Your reference for the cancel request. Maximum length: 80
+ characters.'
+ type: string
+ required:
+ - merchantAccount
+ type: object
+ PaymentCancelResponse:
+ properties:
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentPspReference:
+ description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment to cancel. '
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the cancel request.
+ type: string
+ reference:
+ description: Your reference for the cancel request.
+ type: string
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ required:
+ - status
+ - merchantAccount
+ - paymentPspReference
+ - pspReference
+ type: object
+ PaymentCaptureRequest:
+ properties:
+ amount:
+ description: The amount that you want to capture. The `currency` must match
+ the currency used in authorisation, the `value` must be smaller than or
+ equal to the authorised amount.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ lineItems:
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ platformChargebackLogic:
+ x-addedInVersion: '70'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ reference:
+ description: 'Your reference for the capture request. Maximum length: 80
+ characters.'
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ subMerchants:
+ x-addedInVersion: '70'
+ description: A List of sub-merchants.
+ items:
+ $ref: '#/components/schemas/SubMerchantInfo'
+ type: array
+ required:
+ - merchantAccount
+ - amount
+ type: object
+ PaymentCaptureResponse:
+ properties:
+ amount:
+ description: The captured amount.
+ $ref: '#/components/schemas/Amount'
+ lineItems:
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentPspReference:
+ description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment to capture. '
+ type: string
+ platformChargebackLogic:
+ x-addedInVersion: '70'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ pspReference:
+ description: Adyen's 16-character reference associated with the capture
+ request.
+ type: string
+ reference:
+ description: Your reference for the capture request.
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ subMerchants:
+ x-addedInVersion: '70'
+ description: List of sub-merchants.
+ items:
+ $ref: '#/components/schemas/SubMerchantInfo'
+ type: array
+ required:
+ - status
+ - merchantAccount
+ - amount
+ - pspReference
+ - paymentPspReference
+ type: object
+ PaymentCompletionDetails:
+ properties:
+ MD:
+ description: A payment session identifier returned by the card issuer.
+ maxLength: 20000
+ type: string
+ PaReq:
+ description: (3D) Payment Authentication Request data for the card issuer.
+ type: string
+ PaRes:
+ description: (3D) Payment Authentication Response data by the card issuer.
+ maxLength: 20000
+ type: string
+ authorization_token:
+ type: string
+ billingToken:
+ description: PayPal-generated token for recurring payments.
+ type: string
+ cupsecureplus.smscode:
+ description: The SMS verification code collected from the shopper.
+ type: string
+ facilitatorAccessToken:
+ description: PayPal-generated third party access token.
+ type: string
+ oneTimePasscode:
+ description: A random number sent to the mobile phone number of the shopper
+ to verify the payment.
+ type: string
+ orderID:
+ description: PayPal-assigned ID for the order.
+ type: string
+ payerID:
+ description: PayPal-assigned ID for the payer (shopper).
+ type: string
+ payload:
+ description: Payload appended to the `returnURL` as a result of the redirect.
+ maxLength: 20000
+ type: string
+ paymentID:
+ description: PayPal-generated ID for the payment.
+ type: string
+ paymentStatus:
+ description: 'Value passed from the WeChat MiniProgram `wx.requestPayment`
+ **complete** callback. Possible values: any value starting with `requestPayment:`.'
+ type: string
+ redirectResult:
+ description: The result of the redirect as appended to the `returnURL`.
+ maxLength: 20000
+ type: string
+ resultCode:
+ description: Value you received from the WeChat Pay SDK.
+ type: string
+ threeDSResult:
+ description: 'Base64-encoded string returned by the Component after the
+ challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.'
+ maxLength: 50000
+ type: string
+ threeds2.challengeResult:
+ description: 'Base64-encoded string returned by the Component after the
+ challenge flow. It contains the following parameter: `transStatus`.'
+ maxLength: 50000
+ type: string
+ threeds2.fingerprint:
+ description: 'Base64-encoded string returned by the Component after the
+ challenge flow. It contains the following parameter: `threeDSCompInd`.'
+ maxLength: 100000
+ type: string
+ type: object
+ PaymentDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ type:
+ description: The payment method type.
+ enum:
+ - alipay
+ - multibanco
+ - bankTransfer_IBAN
+ - paybright
+ - paynow
+ - affirm
+ - affirm_pos
+ - trustly
+ - trustlyvector
+ - oney
+ - facilypay
+ - facilypay_3x
+ - facilypay_4x
+ - facilypay_6x
+ - facilypay_10x
+ - facilypay_12x
+ - unionpay
+ - kcp_banktransfer
+ - kcp_payco
+ - kcp_creditcard
+ - wechatpaySDK
+ - wechatpayQR
+ - wechatpayWeb
+ - molpay_boost
+ - wallet_IN
+ - payu_IN_cashcard
+ - payu_IN_nb
+ - upi_qr
+ - paytm
+ - molpay_ebanking_VN
+ - paybybank
+ - ebanking_FI
+ - molpay_ebanking_MY
+ - molpay_ebanking_direct_MY
+ - swish
+ - pix
+ - walley
+ - walley_b2b
+ - alma
+ - paypo
+ - molpay_fpx
+ - konbini
+ - directEbanking
+ - boletobancario
+ - neteller
+ - paysafecard
+ - cashticket
+ - ikano
+ - karenmillen
+ - oasis
+ - warehouse
+ - primeiropay_boleto
+ - mada
+ - benefit
+ - knet
+ - omannet
+ - gopay_wallet
+ - kcp_naverpay
+ - onlinebanking_IN
+ - fawry
+ - atome
+ - moneybookers
+ - naps
+ - nordea
+ - boletobancario_bradesco
+ - boletobancario_itau
+ - boletobancario_santander
+ - boletobancario_bancodobrasil
+ - boletobancario_hsbc
+ - molpay_maybank2u
+ - molpay_cimb
+ - molpay_rhb
+ - molpay_amb
+ - molpay_hlb
+ - molpay_affin_epg
+ - molpay_bankislam
+ - molpay_publicbank
+ - fpx_agrobank
+ - touchngo
+ - maybank2u_mae
+ - duitnow
+ - promptpay
+ - twint_pos
+ - alipay_hk
+ - alipay_hk_web
+ - alipay_hk_wap
+ - alipay_wap
+ - balanceplatform
+ type: string
+ title: Payment Details
+ type: object
+ PaymentDetailsRequest:
+ properties:
+ authenticationData:
+ x-addedInVersion: '69'
+ description: Data for 3DS authentication.
+ $ref: '#/components/schemas/DetailsRequestAuthenticationData'
+ details:
+ description: Use this collection to submit the details that were returned
+ as a result of the `/payments` call.
+ $ref: '#/components/schemas/PaymentCompletionDetails'
+ paymentData:
+ description: 'Encoded payment data. For [authorizing a payment after using
+ 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen):
+
+
+ If you received `resultCode`: **AuthenticationNotRequired** in the `/payments`
+ response, use the `threeDSPaymentData` from the same response.
+
+
+ If you received `resultCode`: **AuthenticationFinished** in the `/payments`
+ response, use the `action.paymentData` from the same response.'
+ maxLength: 200000
+ type: string
+ threeDSAuthenticationOnly:
+ x-addedInVersion: '40'
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ description: Change the `authenticationOnly` indicator originally set in
+ the `/payments` request. Only needs to be set if you want to modify the
+ value set previously.
+ type: boolean
+ required:
+ - details
+ type: object
+ PaymentDetailsResponse:
+ properties:
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
+ - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCard'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
+ - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
+ - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
+ - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
+ - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
+ - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
+ description: 'Contains additional information about the payment. Some data
+ fields are included only if you select them first: Go to **Customer Area**
+ > **Developers** > **Additional data**.'
+ type: object
+ amount:
+ x-addedInVersion: '52'
+ description: Authorised amount in the transaction.
+ $ref: '#/components/schemas/Amount'
+ donationToken:
+ x-addedInVersion: '66'
+ description: Donation Token containing payment details for Adyen Giving.
+ type: string
+ fraudResult:
+ description: The fraud result properties of the payment.
+ $ref: '#/components/schemas/FraudResult'
+ merchantReference:
+ x-addedInVersion: '49'
+ description: The reference used during the /payments request.
+ type: string
+ order:
+ description: Contains updated information regarding the order in case order
+ information was provided in the request.
+ $ref: '#/components/schemas/CheckoutOrderResponse'
+ paymentMethod:
+ x-addedInVersion: '69'
+ description: "Details about the payment method used in the transaction.\
+ \ \nOnly returned if `resultCode` is **Authorised**."
+ $ref: '#/components/schemas/ResponsePaymentMethod'
+ pspReference:
+ description: Adyen's 16-character string reference associated with the transaction/request.
+ This value is globally unique; quote it when communicating with us about
+ this request.
+ type: string
+ refusalReason:
+ description: 'If the payment''s authorisation is refused or an error occurs
+ during authorisation, this field holds Adyen''s mapped reason for the
+ refusal or a description of the error. When a transaction fails, the authorisation
+ response includes `resultCode` and `refusalReason` values.
+
+
+ For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
+ type: string
+ refusalReasonCode:
+ x-addedInVersion: '37'
+ description: Code that specifies the refusal reason. For more information,
+ see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
+ type: string
+ resultCode:
+ description: "The result of the payment. For more information, see [Result\
+ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\
+ \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\
+ \ has been successfully authenticated with 3D Secure 2. Returned for 3D\
+ \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\
+ \ \u2013 The transaction does not require 3D Secure authentication. Returned\
+ \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\
+ * **Authorised** \u2013 The payment was successfully authorised. This\
+ \ state serves as an indicator to proceed with the delivery of goods and\
+ \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\
+ \ payment has been cancelled (either by the shopper or the merchant) before\
+ \ processing was completed. This is a final state.\n* **ChallengeShopper**\
+ \ \u2013 The issuer requires further shopper interaction before the payment\
+ \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\
+ \ \u2013 There was an error when the payment was being processed. The\
+ \ reason is given in the `refusalReason` field. This is a final state.\n\
+ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\
+ \ fingerprint before the payment can be authenticated. Returned for 3D\
+ \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\
+ \ has been authorised for a partial amount.\nThis happens for card payments\
+ \ when the merchant supports Partial Authorisations and the cardholder\
+ \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\
+ \ possible to obtain the final status of the payment. This can happen\
+ \ if the systems providing final status information for the payment are\
+ \ unavailable, or if the shopper needs to take further action to complete\
+ \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\
+ \ contains additional information that you need to present to a shopper,\
+ \ so that they can use it to complete a payment.\n* **Received** \u2013\
+ \ Indicates the payment has successfully been received by Adyen, and will\
+ \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\
+ \ \u2013 Indicates the shopper should be redirected to an external web\
+ \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\
+ \ the payment was refused. The reason is given in the `refusalReason`\
+ \ field. This is a final state."
+ enum:
+ - AuthenticationFinished
+ - AuthenticationNotRequired
+ - Authorised
+ - Cancelled
+ - ChallengeShopper
+ - Error
+ - IdentifyShopper
+ - PartiallyAuthorised
+ - Pending
+ - PresentToShopper
+ - Received
+ - RedirectShopper
+ - Refused
+ - Success
+ type: string
+ shopperLocale:
+ description: The shopperLocale.
+ type: string
+ threeDS2ResponseData:
+ x-addedInVersion: '67'
+ description: Response of the 3D Secure 2 authentication.
+ $ref: '#/components/schemas/ThreeDS2ResponseData'
+ threeDS2Result:
+ x-addedInVersion: '41'
+ description: Result of the 3D Secure 2 authentication.
+ $ref: '#/components/schemas/ThreeDS2Result'
+ threeDSPaymentData:
+ x-addedInVersion: '67'
+ description: When non-empty, contains a value that you must submit to the
+ `/payments/details` endpoint as `paymentData`.
+ type: string
+ type: object
+ PaymentLinkRequest:
+ properties:
+ allowedPaymentMethods:
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The payment amount and currency.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/Address'
+ blockedPaymentMethods:
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ captureDelayHours:
+ x-addedInVersion: '69'
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ countryCode:
+ description: The shopper's two-letter country code.
+ type: string
+ dateOfBirth:
+ x-addedInVersion: '69'
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date
+ type: string
+ deliverAt:
+ description: 'The date and time when the purchased goods should be delivered.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
+ for example, **2020-12-18T10:15:30+01:00**.'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/Address'
+ description:
+ description: 'A short description visible on the payment page.
+
+ Maximum length: 280 characters.'
+ type: string
+ expiresAt:
+ x-addedInVersion: '71'
+ description: 'The date when the payment link expires.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone
+ offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
+
+
+ The maximum expiry date is 70 days after the payment link is created.
+
+
+ If not provided, the payment link expires 24 hours after it was created.'
+ format: date-time
+ type: string
+ installmentOptions:
+ additionalProperties:
+ $ref: '#/components/schemas/InstallmentOption'
+ description: A set of key-value pairs that specifies the installment options
+ available per payment method. The key must be a payment method name in
+ lowercase. For example, **card** to specify installment options for all
+ cards, or **visa** or **mc**. The value must be an object containing the
+ installment options.
+ type: object
+ lineItems:
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ This parameter is required for open invoice (_buy now, pay later_) payment
+ methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ manualCapture:
+ description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
+ type: boolean
+ mcc:
+ x-addedInVersion: '69'
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier for which the payment link
+ is created.
+ type: string
+ merchantOrderReference:
+ description: This reference allows linking multiple transactions to each
+ other for reporting purposes (for example, order auth-rate). The reference
+ should be unique per billing cycle.
+ type: string
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limitations:
+
+ * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs:
+ "Metadata size exceeds limit"
+
+ * Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata
+ key size exceeds limit"
+
+ * A key cannot have the name `checkout.linkId`. Any value that you provide
+ with this key is going to be replaced by the real payment link ID.'
+ maxLength: 80
+ type: object
+ recurringProcessingModel:
+ description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\
+ \ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\
+ \ \u2013 A transaction for a fixed or variable amount, which follows a\
+ \ fixed schedule.\n* **CardOnFile** \u2013 With a card-on-file (CoF) transaction,\
+ \ card details are stored to enable one-click or omnichannel journeys,\
+ \ or simply to streamline the checkout process. Any subscription not following\
+ \ a fixed schedule is also considered a card-on-file transaction.\n* **UnscheduledCardOnFile**\
+ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
+ \ that occurs on a non-fixed schedule and/or has variable amounts. For\
+ \ example, automatic top-ups when a cardholder's balance drops below a\
+ \ certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ reference:
+ description: A reference that is used to uniquely identify the payment in
+ future communications about the payment status.
+ type: string
+ requiredShopperFields:
+ x-addedInVersion: '67'
+ description: "List of fields that the shopper has to provide on the payment\
+ \ page before completing the payment. For more information, refer to [Provide\
+ \ shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).\n\
+ \nPossible values:\n* **billingAddress** \u2013 The address where to send\
+ \ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\
+ \ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\
+ \ email address.\n* **shopperName** \u2013 The shopper's full name.\n\
+ * **telephoneNumber** \u2013 The shopper's phone number.\n"
+ items:
+ enum:
+ - billingAddress
+ - deliveryAddress
+ - shopperEmail
+ - shopperName
+ - telephoneNumber
+ type: string
+ type: array
+ returnUrl:
+ description: 'Website URL used for redirection after payment is completed.
+
+ If provided, a **Continue** button will be shown on the payment page.
+ If shoppers select the button, they are redirected to the specified URL.'
+ type: string
+ reusable:
+ description: Indicates whether the payment link can be reused for multiple
+ payments. If not provided, this defaults to **false** which means the
+ link can be used for one successful payment only.
+ type: boolean
+ riskData:
+ x-addedInVersion: '65'
+ description: Any risk-related settings to apply to the payment.
+ $ref: '#/components/schemas/RiskData'
+ shopperEmail:
+ description: The shopper's email address.
+ type: string
+ shopperLocale:
+ description: 'The language to be used in the payment page, specified by
+ a combination of a language and country code. For example, `en-US`.
+
+
+ For a list of shopper locales that Pay by Link supports, refer to [Language
+ and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
+ type: string
+ shopperName:
+ description: The shopper's full name. This object is required for some payment
+ methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
+ Seller Protection program.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ maxLength: 256
+ minLength: 3
+ type: string
+ shopperStatement:
+ x-addedInVersion: '69'
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ showRemovePaymentMethodButton:
+ default: true
+ description: Set to **false** to hide the button that lets the shopper remove
+ a stored payment method.
+ type: boolean
+ socialSecurityNumber:
+ x-addedInVersion: '69'
+ description: The shopper's social security number.
+ type: string
+ splitCardFundingSources:
+ x-addedInVersion: '69'
+ default: false
+ description: Boolean value indicating whether the card payment method should
+ be split into separate debit and credit options.
+ type: boolean
+ splits:
+ description: An array of objects specifying how to split a payment when
+ using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information),
+ [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information),
+ or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ description: The physical store, for which this payment is processed.
+ type: string
+ storePaymentMethodMode:
+ x-addedInVersion: '68'
+ description: "Indicates if the details of the payment method will be stored\
+ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\
+ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
+ \ is provided, the UI lets the shopper choose if they want their payment\
+ \ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
+ \ is provided, the details will be stored without asking the shopper for\
+ \ consent. \n When set to **askForConsent** or **enabled**, you must also\
+ \ include the `recurringProcessingModel` parameter."
+ enum:
+ - askForConsent
+ - disabled
+ - enabled
+ type: string
+ telephoneNumber:
+ x-addedInVersion: '68'
+ description: The shopper's telephone number.
+ type: string
+ themeId:
+ x-addedInVersion: '67'
+ description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes)
+ to customize the appearance of the payment page. If not specified, the
+ payment page is rendered according to the theme set as default in your
+ Customer Area.
+ type: string
+ required:
+ - amount
+ - reference
+ - merchantAccount
+ type: object
+ PaymentLinkResponse:
+ properties:
+ allowedPaymentMethods:
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The payment amount and currency.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ billingAddress:
+ description: The address where to send the invoice.
+ $ref: '#/components/schemas/Address'
+ blockedPaymentMethods:
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ captureDelayHours:
+ x-addedInVersion: '69'
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ countryCode:
+ description: The shopper's two-letter country code.
+ type: string
+ dateOfBirth:
+ x-addedInVersion: '69'
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date
+ type: string
+ deliverAt:
+ description: 'The date and time when the purchased goods should be delivered.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
+ for example, **2020-12-18T10:15:30+01:00**.'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/Address'
+ description:
+ description: 'A short description visible on the payment page.
+
+ Maximum length: 280 characters.'
+ type: string
+ expiresAt:
+ x-addedInVersion: '71'
+ description: 'The date when the payment link expires.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone
+ offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
+
+
+ The maximum expiry date is 70 days after the payment link is created.
+
+
+ If not provided, the payment link expires 24 hours after it was created.'
+ format: date-time
+ type: string
+ id:
+ x-addedInVersion: '51'
+ description: A unique identifier of the payment link.
+ readOnly: true
+ type: string
+ installmentOptions:
+ additionalProperties:
+ $ref: '#/components/schemas/InstallmentOption'
+ description: A set of key-value pairs that specifies the installment options
+ available per payment method. The key must be a payment method name in
+ lowercase. For example, **card** to specify installment options for all
+ cards, or **visa** or **mc**. The value must be an object containing the
+ installment options.
+ type: object
+ lineItems:
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ This parameter is required for open invoice (_buy now, pay later_) payment
+ methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ manualCapture:
+ description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
+ type: boolean
+ mcc:
+ x-addedInVersion: '69'
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier for which the payment link
+ is created.
+ type: string
+ merchantOrderReference:
+ description: This reference allows linking multiple transactions to each
+ other for reporting purposes (for example, order auth-rate). The reference
+ should be unique per billing cycle.
+ type: string
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limitations:
+
+ * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs:
+ "Metadata size exceeds limit"
+
+ * Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata
+ key size exceeds limit"
+
+ * A key cannot have the name `checkout.linkId`. Any value that you provide
+ with this key is going to be replaced by the real payment link ID.'
+ maxLength: 80
+ type: object
+ recurringProcessingModel:
+ description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\
+ \ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\
+ \ \u2013 A transaction for a fixed or variable amount, which follows a\
+ \ fixed schedule.\n* **CardOnFile** \u2013 With a card-on-file (CoF) transaction,\
+ \ card details are stored to enable one-click or omnichannel journeys,\
+ \ or simply to streamline the checkout process. Any subscription not following\
+ \ a fixed schedule is also considered a card-on-file transaction.\n* **UnscheduledCardOnFile**\
+ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
+ \ that occurs on a non-fixed schedule and/or has variable amounts. For\
+ \ example, automatic top-ups when a cardholder's balance drops below a\
+ \ certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ reference:
+ description: A reference that is used to uniquely identify the payment in
+ future communications about the payment status.
+ type: string
+ requiredShopperFields:
+ x-addedInVersion: '67'
+ description: "List of fields that the shopper has to provide on the payment\
+ \ page before completing the payment. For more information, refer to [Provide\
+ \ shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).\n\
+ \nPossible values:\n* **billingAddress** \u2013 The address where to send\
+ \ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\
+ \ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\
+ \ email address.\n* **shopperName** \u2013 The shopper's full name.\n\
+ * **telephoneNumber** \u2013 The shopper's phone number.\n"
+ items:
+ enum:
+ - billingAddress
+ - deliveryAddress
+ - shopperEmail
+ - shopperName
+ - telephoneNumber
+ type: string
+ type: array
+ returnUrl:
+ description: 'Website URL used for redirection after payment is completed.
+
+ If provided, a **Continue** button will be shown on the payment page.
+ If shoppers select the button, they are redirected to the specified URL.'
+ type: string
+ reusable:
+ description: Indicates whether the payment link can be reused for multiple
+ payments. If not provided, this defaults to **false** which means the
+ link can be used for one successful payment only.
+ type: boolean
+ riskData:
+ x-addedInVersion: '65'
+ description: Any risk-related settings to apply to the payment.
+ $ref: '#/components/schemas/RiskData'
+ shopperEmail:
+ description: The shopper's email address.
+ type: string
+ shopperLocale:
+ description: 'The language to be used in the payment page, specified by
+ a combination of a language and country code. For example, `en-US`.
+
+
+ For a list of shopper locales that Pay by Link supports, refer to [Language
+ and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
+ type: string
+ shopperName:
+ description: The shopper's full name. This object is required for some payment
+ methods such as AfterPay, Klarna, or if you're enrolled in the PayPal
+ Seller Protection program.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ maxLength: 256
+ minLength: 3
+ type: string
+ shopperStatement:
+ x-addedInVersion: '69'
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ showRemovePaymentMethodButton:
+ default: true
+ description: Set to **false** to hide the button that lets the shopper remove
+ a stored payment method.
+ type: boolean
+ socialSecurityNumber:
+ x-addedInVersion: '69'
+ description: The shopper's social security number.
+ type: string
+ splitCardFundingSources:
+ x-addedInVersion: '69'
+ default: false
+ description: Boolean value indicating whether the card payment method should
+ be split into separate debit and credit options.
+ type: boolean
+ splits:
+ description: An array of objects specifying how to split a payment when
+ using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information),
+ [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information),
+ or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ status:
+ description: 'Status of the payment link. Possible values:
+
+ * **active**: The link can be used to make payments.
+
+ * **expired**: The expiry date for the payment link has passed. Shoppers
+ can no longer use the link to make payments.
+
+ * **completed**: The shopper completed the payment.
+
+ * **paymentPending**: The shopper is in the process of making the payment.
+ Applies to payment methods with an asynchronous flow.'
+ enum:
+ - active
+ - completed
+ - expired
+ - paid
+ - paymentPending
+ type: string
+ store:
+ description: The physical store, for which this payment is processed.
+ type: string
+ storePaymentMethodMode:
+ x-addedInVersion: '68'
+ description: "Indicates if the details of the payment method will be stored\
+ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\
+ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\
+ \ is provided, the UI lets the shopper choose if they want their payment\
+ \ details to be stored.\n* **enabled** \u2013 If the `shopperReference`\
+ \ is provided, the details will be stored without asking the shopper for\
+ \ consent. \n When set to **askForConsent** or **enabled**, you must also\
+ \ include the `recurringProcessingModel` parameter."
+ enum:
+ - askForConsent
+ - disabled
+ - enabled
+ type: string
+ telephoneNumber:
+ x-addedInVersion: '68'
+ description: The shopper's telephone number.
+ type: string
+ themeId:
+ x-addedInVersion: '67'
+ description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes)
+ to customize the appearance of the payment page. If not specified, the
+ payment page is rendered according to the theme set as default in your
+ Customer Area.
+ type: string
+ updatedAt:
+ description: 'The date when the payment link status was updated.
+
+
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD,
+ for example, **2020-12-18T10:15:30+01:00**.'
+ format: date-time
+ type: string
+ url:
+ description: The URL at which the shopper can complete the payment.
+ readOnly: true
+ type: string
+ required:
+ - amount
+ - reference
+ - merchantAccount
+ - id
+ - url
+ - status
+ type: object
+ PaymentMethod:
+ properties:
+ brand:
+ x-addedInVersion: '65'
+ description: 'Brand for the selected gift card. For example: plastix, hmclub.'
+ type: string
+ brands:
+ x-addedInVersion: '49'
+ description: 'List of possible brands. For example: visa, mc.'
+ items:
+ type: string
+ type: array
+ configuration:
+ additionalProperties:
+ type: string
+ description: The configuration of the payment method.
+ type: object
+ fundingSource:
+ x-addedInVersion: '53'
+ description: The funding source of the payment method.
+ enum:
+ - credit
+ - debit
+ type: string
+ group:
+ description: The group where this payment method belongs to.
+ $ref: '#/components/schemas/PaymentMethodGroup'
+ inputDetails:
+ deprecated: true
+ description: All input details to be provided to complete the payment with
+ this payment method.
+ items:
+ $ref: '#/components/schemas/InputDetail'
+ type: array
+ issuers:
+ x-addedInVersion: '68'
+ description: A list of issuers for this payment method.
+ items:
+ $ref: '#/components/schemas/PaymentMethodIssuer'
+ type: array
+ name:
+ description: The displayable name of this payment method.
+ type: string
+ type:
+ description: The unique payment method code.
+ type: string
+ type: object
+ PaymentMethodGroup:
+ properties:
+ name:
+ description: The name of the group.
+ type: string
+ paymentMethodData:
+ description: Echo data to be used if the payment method is displayed as
+ part of this group.
+ type: string
+ type:
+ description: The unique code of the group.
+ type: string
+ type: object
+ PaymentMethodIssuer:
+ properties:
+ disabled:
+ default: false
+ description: A boolean value indicating whether this issuer is unavailable.
+ Can be `true` whenever the issuer is offline.
+ type: boolean
+ id:
+ description: The unique identifier of this issuer, to submit in requests
+ to /payments.
+ type: string
+ name:
+ description: A localized name of the issuer.
+ type: string
+ required:
+ - id
+ - name
+ type: object
+ PaymentMethodsRequest:
+ properties:
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ allowedPaymentMethods:
+ x-addedInVersion: '33'
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
+ For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ requests, set amount to 0 (zero).
+ $ref: '#/components/schemas/Amount'
+ blockedPaymentMethods:
+ x-addedInVersion: '33'
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field can be used for filtering out payment methods that are only available
+ on specific platforms. Possible values:
+
+ * iOS
+
+ * Android
+
+ * Web'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ countryCode:
+ description: The shopper's country code.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ order:
+ x-addedInVersion: '64'
+ description: The order information required for partial payments.
+ $ref: '#/components/schemas/EncryptedOrderData'
+ shopperLocale:
+ x-addedInVersion: '7'
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ type: string
+ splitCardFundingSources:
+ x-addedInVersion: '53'
+ default: false
+ description: Boolean value indicating whether the card payment method should
+ be split into separate debit and credit options.
+ type: boolean
+ store:
+ x-addedInVersion: '23'
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ maxLength: 16
+ minLength: 1
+ type: string
+ required:
+ - merchantAccount
+ type: object
+ PaymentMethodsResponse:
+ properties:
+ paymentMethods:
+ description: Detailed list of payment methods required to generate payment
+ forms.
+ items:
+ $ref: '#/components/schemas/PaymentMethod'
+ type: array
+ storedPaymentMethods:
+ x-addedInVersion: '49'
+ description: List of all stored payment methods.
+ items:
+ $ref: '#/components/schemas/StoredPaymentMethod'
+ type: array
+ type: object
+ PaymentRefundRequest:
+ properties:
+ amount:
+ description: The amount that you want to refund. The `currency` must match
+ the currency used in authorisation, the `value` must be smaller than or
+ equal to the authorised amount.
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ lineItems:
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ merchantRefundReason:
+ description: Your reason for the refund request
+ enum:
+ - FRAUD
+ - CUSTOMER REQUEST
+ - RETURN
+ - DUPLICATE
+ - OTHER
+ type: string
+ reference:
+ description: 'Your reference for the refund request. Maximum length: 80
+ characters.'
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores)
+ that is processing the refund. This must be the same as the store name
+ configured in your Customer Area. Otherwise, you get an error and the
+ refund fails.
+ type: string
+ required:
+ - merchantAccount
+ - amount
+ type: object
+ PaymentRefundResponse:
+ properties:
+ amount:
+ description: The refund amount.
+ $ref: '#/components/schemas/Amount'
+ lineItems:
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ merchantRefundReason:
+ description: Your reason for the refund request.
+ enum:
+ - FRAUD
+ - CUSTOMER REQUEST
+ - RETURN
+ - DUPLICATE
+ - OTHER
+ type: string
+ paymentPspReference:
+ description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment to refund. '
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the refund request.
+ type: string
+ reference:
+ description: Your reference for the refund request.
+ type: string
+ splits:
+ description: An array of objects specifying how the amount should be split
+ between accounts when using Adyen for Platforms. For details, refer to
+ [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ store:
+ description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores)
+ that is processing the refund. This must be the same as the store name
+ configured in your Customer Area. Otherwise, you get an error and the
+ refund fails.
+ type: string
+ required:
+ - status
+ - merchantAccount
+ - amount
+ - pspReference
+ - paymentPspReference
+ type: object
+ PaymentRequest:
+ properties:
+ accountInfo:
+ x-addedInVersion: '40'
+ description: 'Shopper account information for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/AccountInfo'
+ additionalAmount:
+ description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ request to use a non-zero value, assign this value to `additionalAmount`
+ (while the amount must be still set to 0 to trigger BIN or card verification).
+
+ Required to be in the same currency as the `amount`. '
+ $ref: '#/components/schemas/Amount'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ amount:
+ description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
+ For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ requests, set amount to 0 (zero).
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ x-addedInVersion: '40'
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ authenticationData:
+ x-addedInVersion: '69'
+ description: Data for 3DS authentication.
+ $ref: '#/components/schemas/AuthenticationData'
+ billingAddress:
+ description: 'The address where to send the invoice.
+
+ > The `billingAddress` object is required in the following scenarios.
+ Include all of the fields within this object.
+
+ >* For 3D Secure 2 transactions in all browser-based and mobile implementations.
+
+ >* For cross-border payouts to and from Canada.'
+ $ref: '#/components/schemas/BillingAddress'
+ browserInfo:
+ description: 'The shopper''s browser information.
+
+ > For 3D Secure, the full object is required for web integrations. For
+ mobile app integrations, include the `userAgent` and `acceptHeader` fields
+ to indicate that your integration can support a redirect in case a payment
+ is routed to 3D Secure 1.'
+ $ref: '#/components/schemas/BrowserInfo'
+ captureDelayHours:
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field is optional for filtering out payment methods that are only available
+ on specific platforms. If this value is not set, then we will try to infer
+ it from the `sdkVersion` or `token`.
+
+
+ Possible values:
+
+ * iOS
+
+ * Android
+
+ * Web'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: Checkout attempt ID that corresponds to the Id generated by
+ the client SDK for tracking user payment journey.
+ type: string
+ company:
+ x-addedInVersion: '32'
+ description: Information regarding the company.
+ $ref: '#/components/schemas/Company'
+ conversionId:
+ x-addedInVersion: '49'
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `checkoutAttemptId` instead
+ description: Conversion ID that corresponds to the Id generated by the client
+ SDK for tracking user payment journey.
+ type: string
+ countryCode:
+ description: 'The shopper country.
+
+
+ Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+
+ Example: NL or DE'
+ type: string
+ dateOfBirth:
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date-time
+ type: string
+ dccQuote:
+ description: The forex quote as returned in the response of the forex service.
+ $ref: '#/components/schemas/ForexQuote'
+ deliverAt:
+ x-addedInVersion: '70'
+ description: 'The date and time the purchased goods should be delivered.
+
+
+ Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
+
+
+ Example: 2017-07-17T13:42:40.428+01:00'
+ format: date-time
+ type: string
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/DeliveryAddress'
+ deliveryDate:
+ deprecated: true
+ x-deprecatedInVersion: '70'
+ x-deprecatedMessage: Use `deliverAt` instead.
+ description: 'The date and time the purchased goods should be delivered.
+
+
+ Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
+
+
+ Example: 2017-07-17T13:42:40.428+01:00'
+ format: date-time
+ type: string
+ deviceFingerprint:
+ description: A string containing the shopper's device fingerprint. For more
+ information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
+ maxLength: 5000
+ type: string
+ enableOneClick:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the shopper will
+ be asked if the payment details should be stored for future one-click
+ payments.
+ type: boolean
+ enablePayOut:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for payouts.
+ type: boolean
+ enableRecurring:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for recurring payments.
+ type: boolean
+ entityType:
+ description: The type of the entity the payment is processed for.
+ enum:
+ - NaturalPerson
+ - CompanyName
+ type: string
+ fraudOffset:
+ description: An integer value that is added to the normal fraud score. The
+ value can be either positive or negative.
+ format: int32
+ type: integer
+ fundOrigin:
+ description: The person or entity funding the money.
+ $ref: '#/components/schemas/FundOrigin'
+ fundRecipient:
+ description: the person or entity receiving the money
+ $ref: '#/components/schemas/FundRecipient'
+ industryUsage:
+ x-addedInVersion: '70'
+ description: "The reason for the amount update. Possible values: \n* **delayedCharge**\
+ \ \n* **noShow** \n* **installment**"
+ enum:
+ - delayedCharge
+ - installment
+ - noShow
+ type: string
+ installments:
+ description: Contains installment settings. For more information, refer
+ to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
+ $ref: '#/components/schemas/Installments'
+ lineItems:
+ x-addedInVersion: '32'
+ description: 'Price and product information about the purchased items, to
+ be included on the invoice sent to the shopper.
+
+ > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna,
+ Ratepay, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ localizedShopperStatement:
+ x-addedInVersion: '68'
+ additionalProperties:
+ type: string
+ description: "The `localizedShopperStatement` field lets you use dynamic\
+ \ values for your shopper statement in a local character set.\nIf not\
+ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\
+ \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\
+ \ and Mastercard payments in Japan using Japanese cards. This character\
+ \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\
+ \ special characters. \n* Half-width or full-width characters."
+ type: object
+ mandate:
+ description: The mandate details to initiate recurring transaction.
+ $ref: '#/components/schemas/Mandate'
+ mcc:
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantOrderReference:
+ description: 'This reference allows linking multiple transactions to each
+ other for reporting purposes (i.e. order auth-rate). The reference should
+ be unique per billing cycle.
+
+ The same merchant order reference should never be reused after the first
+ authorised attempt. If used, this field should be supplied for all incoming
+ authorisations.
+
+ > We strongly recommend you send the `merchantOrderReference` value to
+ benefit from linking payment requests when authorisation retries take
+ place. In addition, we recommend you provide `retry.orderAttemptNumber`,
+ `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
+ type: string
+ merchantRiskIndicator:
+ x-addedInVersion: '40'
+ description: 'Additional risk fields for 3D Secure 2.
+
+ > For 3D Secure 2 transactions, we recommend that you include this object
+ to increase the chances of achieving a frictionless flow.'
+ $ref: '#/components/schemas/MerchantRiskIndicator'
+ metadata:
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request. When exceeding, the "177" error
+ occurs: "Metadata size exceeds limit".
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ mpiData:
+ description: Authentication data produced by an MPI (Mastercard SecureCode,
+ Visa Secure, or Cartes Bancaires).
+ $ref: '#/components/schemas/ThreeDSecureData'
+ order:
+ description: The order information required for partial payments.
+ $ref: '#/components/schemas/EncryptedOrderData'
+ orderReference:
+ description: When you are doing multiple partial (gift card) payments, this
+ is the `pspReference` of the first payment. We use this to link the multiple
+ payments to each other. As your own reference for linking multiple payments,
+ use the `merchantOrderReference`instead.
+ type: string
+ origin:
+ x-addedInVersion: '40'
+ description: 'Required for the 3D Secure 2 `channel` **Web** integration.
+
+
+ Set this parameter to the origin URL of the page that you are loading
+ the 3D Secure Component from.'
+ maxLength: 80
+ type: string
+ paymentMethod:
+ description: The type and required details of a payment method to use.
+ oneOf:
+ - $ref: '#/components/schemas/AchDetails'
+ - $ref: '#/components/schemas/AfterpayDetails'
+ - $ref: '#/components/schemas/AmazonPayDetails'
+ - $ref: '#/components/schemas/AndroidPayDetails'
+ - $ref: '#/components/schemas/ApplePayDetails'
+ - $ref: '#/components/schemas/BacsDirectDebitDetails'
+ - $ref: '#/components/schemas/BillDeskDetails'
+ - $ref: '#/components/schemas/BlikDetails'
+ - $ref: '#/components/schemas/CardDetails'
+ - $ref: '#/components/schemas/CellulantDetails'
+ - $ref: '#/components/schemas/DokuDetails'
+ - $ref: '#/components/schemas/DotpayDetails'
+ - $ref: '#/components/schemas/DragonpayDetails'
+ - $ref: '#/components/schemas/EcontextVoucherDetails'
+ - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails'
+ - $ref: '#/components/schemas/GiropayDetails'
+ - $ref: '#/components/schemas/GooglePayDetails'
+ - $ref: '#/components/schemas/IdealDetails'
+ - $ref: '#/components/schemas/KlarnaDetails'
+ - $ref: '#/components/schemas/MasterpassDetails'
+ - $ref: '#/components/schemas/MbwayDetails'
+ - $ref: '#/components/schemas/MobilePayDetails'
+ - $ref: '#/components/schemas/MolPayDetails'
+ - $ref: '#/components/schemas/OpenInvoiceDetails'
+ - $ref: '#/components/schemas/PayPalDetails'
+ - $ref: '#/components/schemas/PayUUpiDetails'
+ - $ref: '#/components/schemas/PayWithGoogleDetails'
+ - $ref: '#/components/schemas/PaymentDetails'
+ - $ref: '#/components/schemas/RatepayDetails'
+ - $ref: '#/components/schemas/SamsungPayDetails'
+ - $ref: '#/components/schemas/SepaDirectDebitDetails'
+ - $ref: '#/components/schemas/StoredPaymentMethodDetails'
+ - $ref: '#/components/schemas/UpiCollectDetails'
+ - $ref: '#/components/schemas/UpiIntentDetails'
+ - $ref: '#/components/schemas/VippsDetails'
+ - $ref: '#/components/schemas/VisaCheckoutDetails'
+ - $ref: '#/components/schemas/WeChatPayDetails'
+ - $ref: '#/components/schemas/WeChatPayMiniProgramDetails'
+ - $ref: '#/components/schemas/ZipDetails'
+ platformChargebackLogic:
+ x-addedInVersion: '68'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ recurringExpiry:
+ description: Date after which no further authorisations shall be performed.
+ Only for 3D Secure 2.
+ type: string
+ recurringFrequency:
+ description: Minimum number of days between authorisations. Only for 3D
+ Secure 2.
+ type: string
+ recurringProcessingModel:
+ x-addedInVersion: '30'
+ description: "Defines a recurring payment type. Required when creating a\
+ \ token to store payment details or using stored payment details.\nAllowed\
+ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\
+ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 With\
+ \ a card-on-file (CoF) transaction, card details are stored to enable\
+ \ one-click or omnichannel journeys, or simply to streamline the checkout\
+ \ process. Any subscription not following a fixed schedule is also considered\
+ \ a card-on-file transaction.\n* `UnscheduledCardOnFile` \u2013 An unscheduled\
+ \ card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed\
+ \ schedule and/or have variable amounts. For example, automatic top-ups\
+ \ when a cardholder's balance drops below a certain amount.\n"
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ redirectFromIssuerMethod:
+ x-addedInVersion: '32'
+ description: Specifies the redirect method (GET or POST) when redirecting
+ back from the issuer.
+ type: string
+ redirectToIssuerMethod:
+ x-addedInVersion: '32'
+ description: Specifies the redirect method (GET or POST) when redirecting
+ to the issuer.
+ type: string
+ reference:
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement.
+
+ If you need to provide multiple references for a transaction, separate
+ them with hyphens ("-").
+
+ Maximum length: 80 characters.'
+ type: string
+ returnUrl:
+ description: "The URL to return to in case of a redirection.\nThe format\
+ \ depends on the channel. \n* For web, include the protocol `http://`\
+ \ or `https://`. You can also include your own additional query parameters,\
+ \ for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n\
+ * For iOS, use the custom URL for your app. To know more about setting\
+ \ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\n\
+ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\
+ \ on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\n\
+ Example: `my-app://your.package.name`"
+ type: string
+ riskData:
+ description: Contains risk data, such as client-side data, used to identify
+ risk for a transaction.
+ $ref: '#/components/schemas/RiskData'
+ sessionValidity:
+ description: 'The date and time until when the session remains valid, in
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
+
+
+ For example: 2020-07-18T15:42:40.428+01:00'
+ type: string
+ shopperEmail:
+ description: 'The shopper''s email address. We recommend that you provide
+ this data, as it is used in velocity fraud checks.
+
+ > For 3D Secure 2 transactions, schemes require `shopperEmail` for all
+ browser-based and mobile implementations.'
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ description: The shopper's full name.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ maxLength: 256
+ minLength: 3
+ type: string
+ shopperStatement:
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ socialSecurityNumber:
+ description: The shopper's social security number.
+ type: string
+ splits:
+ x-addedInVersion: '37'
+ description: An array of objects specifying how to split a payment when
+ using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information),
+ [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information),
+ or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ maxLength: 64
+ minLength: 1
+ type: string
+ storePaymentMethod:
+ x-addedInVersion: '49'
+ description: When true and `shopperReference` is provided, the payment details
+ will be stored.
+ type: boolean
+ telephoneNumber:
+ description: The shopper's telephone number.
+ type: string
+ threeDS2RequestData:
+ x-addedInVersion: '40'
+ description: Request fields for 3D Secure 2. To check if any of the following
+ fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments)
+ or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
+ $ref: '#/components/schemas/ThreeDS2RequestFields'
+ threeDSAuthenticationOnly:
+ x-addedInVersion: '50'
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ trustedShopper:
+ x-addedInVersion: '37'
+ description: Set to true if the payment should be routed to a trusted MID.
+ type: boolean
+ required:
+ - merchantAccount
+ - reference
+ - amount
+ - paymentMethod
+ - returnUrl
+ type: object
+ PaymentResponse:
+ properties:
+ action:
+ x-addedInVersion: '49'
+ description: Action to be taken for completing the payment.
+ oneOf:
+ - $ref: '#/components/schemas/CheckoutAwaitAction'
+ - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction'
+ - $ref: '#/components/schemas/CheckoutNativeRedirectAction'
+ - $ref: '#/components/schemas/CheckoutQrCodeAction'
+ - $ref: '#/components/schemas/CheckoutRedirectAction'
+ - $ref: '#/components/schemas/CheckoutSDKAction'
+ - $ref: '#/components/schemas/CheckoutThreeDS2Action'
+ - $ref: '#/components/schemas/CheckoutVoucherAction'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
+ - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCard'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
+ - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
+ - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
+ - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
+ - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
+ - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
+ description: 'Contains additional information about the payment. Some data
+ fields are included only if you select them first: Go to **Customer Area**
+ > **Developers** > **Additional data**.'
+ type: object
+ amount:
+ x-addedInVersion: '52'
+ description: Authorised amount in the transaction.
+ $ref: '#/components/schemas/Amount'
+ donationToken:
+ x-addedInVersion: '66'
+ description: Donation Token containing payment details for Adyen Giving.
+ type: string
+ fraudResult:
+ description: The fraud result properties of the payment.
+ $ref: '#/components/schemas/FraudResult'
+ merchantReference:
+ x-addedInVersion: '49'
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement.
+
+ If you need to provide multiple references for a transaction, separate
+ them with hyphens ("-").
+
+ Maximum length: 80 characters.'
+ type: string
+ order:
+ description: Contains updated information regarding the order in case order
+ information was provided in the request.
+ $ref: '#/components/schemas/CheckoutOrderResponse'
+ paymentMethod:
+ x-addedInVersion: '69'
+ description: "Details about the payment method used in the transaction.\
+ \ \nOnly returned if `resultCode` is **Authorised**."
+ $ref: '#/components/schemas/ResponsePaymentMethod'
+ pspReference:
+ description: 'Adyen''s 16-character string reference associated with the
+ transaction/request. This value is globally unique; quote it when communicating
+ with us about this request.
+
+
+ > For payment methods that require a redirect or additional action, you
+ will get this value in the `/payments/details` response.'
+ type: string
+ refusalReason:
+ description: 'If the payment''s authorisation is refused or an error occurs
+ during authorisation, this field holds Adyen''s mapped reason for the
+ refusal or a description of the error. When a transaction fails, the authorisation
+ response includes `resultCode` and `refusalReason` values.
+
+
+ For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
+ type: string
+ refusalReasonCode:
+ x-addedInVersion: '37'
+ description: Code that specifies the refusal reason. For more information,
+ see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
+ type: string
+ resultCode:
+ description: "The result of the payment. For more information, see [Result\
+ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\
+ \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\
+ \ has been successfully authenticated with 3D Secure 2. Returned for 3D\
+ \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\
+ \ \u2013 The transaction does not require 3D Secure authentication. Returned\
+ \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\
+ * **Authorised** \u2013 The payment was successfully authorised. This\
+ \ state serves as an indicator to proceed with the delivery of goods and\
+ \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\
+ \ payment has been cancelled (either by the shopper or the merchant) before\
+ \ processing was completed. This is a final state.\n* **ChallengeShopper**\
+ \ \u2013 The issuer requires further shopper interaction before the payment\
+ \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\
+ \ \u2013 There was an error when the payment was being processed. The\
+ \ reason is given in the `refusalReason` field. This is a final state.\n\
+ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\
+ \ fingerprint before the payment can be authenticated. Returned for 3D\
+ \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\
+ \ has been authorised for a partial amount.\nThis happens for card payments\
+ \ when the merchant supports Partial Authorisations and the cardholder\
+ \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\
+ \ possible to obtain the final status of the payment. This can happen\
+ \ if the systems providing final status information for the payment are\
+ \ unavailable, or if the shopper needs to take further action to complete\
+ \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\
+ \ contains additional information that you need to present to a shopper,\
+ \ so that they can use it to complete a payment.\n* **Received** \u2013\
+ \ Indicates the payment has successfully been received by Adyen, and will\
+ \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\
+ \ \u2013 Indicates the shopper should be redirected to an external web\
+ \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\
+ \ the payment was refused. The reason is given in the `refusalReason`\
+ \ field. This is a final state."
+ enum:
+ - AuthenticationFinished
+ - AuthenticationNotRequired
+ - Authorised
+ - Cancelled
+ - ChallengeShopper
+ - Error
+ - IdentifyShopper
+ - PartiallyAuthorised
+ - Pending
+ - PresentToShopper
+ - Received
+ - RedirectShopper
+ - Refused
+ - Success
+ type: string
+ threeDS2ResponseData:
+ x-addedInVersion: '67'
+ description: Response of the 3D Secure 2 authentication.
+ $ref: '#/components/schemas/ThreeDS2ResponseData'
+ threeDS2Result:
+ x-addedInVersion: '41'
+ description: Result of the 3D Secure 2 authentication.
+ $ref: '#/components/schemas/ThreeDS2Result'
+ threeDSPaymentData:
+ x-addedInVersion: '67'
+ description: When non-empty, contains a value that you must submit to the
+ `/payments/details` endpoint as `paymentData`.
+ type: string
+ type: object
+ PaymentReversalRequest:
+ properties:
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ reference:
+ description: 'Your reference for the reversal request. Maximum length: 80
+ characters.'
+ type: string
+ required:
+ - merchantAccount
+ type: object
+ PaymentReversalResponse:
+ properties:
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentPspReference:
+ description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference)
+ of the payment to reverse. '
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the reversal
+ request.
+ type: string
+ reference:
+ description: Your reference for the reversal request.
+ type: string
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ required:
+ - status
+ - merchantAccount
+ - pspReference
+ - paymentPspReference
+ type: object
+ PaymentSetupRequest:
+ properties:
+ additionalAmount:
+ description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ request to use a non-zero value, assign this value to `additionalAmount`
+ (while the amount must be still set to 0 to trigger BIN or card verification).
+
+ Required to be in the same currency as the `amount`. '
+ $ref: '#/components/schemas/Amount'
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/AdditionalData3DSecure'
+ - $ref: '#/components/schemas/AdditionalDataAirline'
+ - $ref: '#/components/schemas/AdditionalDataCarRental'
+ - $ref: '#/components/schemas/AdditionalDataCommon'
+ - $ref: '#/components/schemas/AdditionalDataLevel23'
+ - $ref: '#/components/schemas/AdditionalDataLodging'
+ - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
+ - $ref: '#/components/schemas/AdditionalDataOpi'
+ - $ref: '#/components/schemas/AdditionalDataRatepay'
+ - $ref: '#/components/schemas/AdditionalDataRetry'
+ - $ref: '#/components/schemas/AdditionalDataRisk'
+ - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
+ - $ref: '#/components/schemas/AdditionalDataSubMerchant'
+ - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
+ - $ref: '#/components/schemas/AdditionalDataWallets'
+ description: 'This field contains additional data, which may be required
+ for a particular payment request.
+
+
+ The `additionalData` object consists of entries, each of which includes
+ the key and value.'
+ type: object
+ allowedPaymentMethods:
+ x-addedInVersion: '33'
+ description: 'List of payment methods to be presented to the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"allowedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ amount:
+ description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)).
+ For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification)
+ requests, set amount to 0 (zero).
+ $ref: '#/components/schemas/Amount'
+ applicationInfo:
+ x-addedInVersion: '40'
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ billingAddress:
+ x-addedInVersion: '4'
+ description: 'The address where to send the invoice.
+
+ > The `billingAddress` object is required in the following scenarios.
+ Include all of the fields within this object.
+
+ >* For 3D Secure 2 transactions in all browser-based and mobile implementations.
+
+ >* For cross-border payouts to and from Canada.'
+ $ref: '#/components/schemas/Address'
+ blockedPaymentMethods:
+ x-addedInVersion: '33'
+ description: 'List of payment methods to be hidden from the shopper. To
+ refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).
+
+
+ Example: `"blockedPaymentMethods":["ideal","giropay"]`'
+ items:
+ type: string
+ type: array
+ captureDelayHours:
+ x-addedInVersion: '2'
+ description: The delay between the authorisation and scheduled auto-capture,
+ specified in hours.
+ format: int32
+ type: integer
+ channel:
+ description: 'The platform where a payment transaction takes place. This
+ field is optional for filtering out payment methods that are only available
+ on specific platforms. If this value is not set, then we will try to infer
+ it from the `sdkVersion` or `token`.
+
+
+ Possible values:
+
+ * iOS
+
+ * Android
+
+ * Web'
+ enum:
+ - iOS
+ - Android
+ - Web
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: Checkout attempt ID that corresponds to the Id generated by
+ the client SDK for tracking user payment journey.
+ type: string
+ company:
+ x-addedInVersion: '32'
+ description: Information regarding the company.
+ $ref: '#/components/schemas/Company'
+ configuration:
+ description: Specify configurations to enable additional features.
+ $ref: '#/components/schemas/Configuration'
+ conversionId:
+ x-addedInVersion: '49'
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `checkoutAttemptId` instead
+ description: Conversion ID that corresponds to the Id generated by the client
+ SDK for tracking user payment journey.
+ type: string
+ countryCode:
+ description: 'The shopper country.
+
+
+ Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+
+ Example: NL or DE'
+ type: string
+ dateOfBirth:
+ x-addedInVersion: '7'
+ description: 'The shopper''s date of birth.
+
+
+ Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
+ format: date
+ type: string
+ dccQuote:
+ description: The forex quote as returned in the response of the forex service.
+ $ref: '#/components/schemas/ForexQuote'
+ deliveryAddress:
+ description: The address where the purchased goods should be delivered.
+ $ref: '#/components/schemas/Address'
+ deliveryDate:
+ x-addedInVersion: '8'
+ description: 'The date and time the purchased goods should be delivered.
+
+
+ Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD
+
+
+ Example: 2017-07-17T13:42:40.428+01:00'
+ format: date-time
+ type: string
+ enableOneClick:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the shopper will
+ be asked if the payment details should be stored for future one-click
+ payments.
+ type: boolean
+ enablePayOut:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for payouts.
+ type: boolean
+ enableRecurring:
+ x-addedInVersion: '32'
+ description: When true and `shopperReference` is provided, the payment details
+ will be tokenized for recurring payments.
+ type: boolean
+ entityType:
+ x-addedInVersion: '24'
+ description: The type of the entity the payment is processed for.
+ enum:
+ - NaturalPerson
+ - CompanyName
+ type: string
+ fraudOffset:
+ description: An integer value that is added to the normal fraud score. The
+ value can be either positive or negative.
+ format: int32
+ type: integer
+ installments:
+ x-addedInVersion: '4'
+ description: Contains installment settings. For more information, refer
+ to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
+ $ref: '#/components/schemas/Installments'
+ lineItems:
+ x-addedInVersion: '32'
+ description: 'Price and product information of the refunded items, required
+ for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
+
+ > This field is required for partial refunds with 3x 4x Oney, Affirm,
+ Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
+ items:
+ $ref: '#/components/schemas/LineItem'
+ type: array
+ localizedShopperStatement:
+ x-addedInVersion: '68'
+ additionalProperties:
+ type: string
+ description: "The `localizedShopperStatement` field lets you use dynamic\
+ \ values for your shopper statement in a local character set.\nIf not\
+ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\
+ \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\
+ \ and Mastercard payments in Japan using Japanese cards. This character\
+ \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\
+ \ special characters. \n* Half-width or full-width characters."
+ type: object
+ mandate:
+ description: The mandate details to initiate recurring transaction.
+ $ref: '#/components/schemas/Mandate'
+ mcc:
+ x-addedInVersion: '12'
+ description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code)
+ (MCC) is a four-digit number, which relates to a particular market segment.
+ This code reflects the predominant activity that is conducted by the merchant.
+ type: string
+ merchantAccount:
+ description: The merchant account identifier, with which you want to process
+ the transaction.
+ type: string
+ merchantOrderReference:
+ x-addedInVersion: '9'
+ description: 'This reference allows linking multiple transactions to each
+ other for reporting purposes (i.e. order auth-rate). The reference should
+ be unique per billing cycle.
+
+ The same merchant order reference should never be reused after the first
+ authorised attempt. If used, this field should be supplied for all incoming
+ authorisations.
+
+ > We strongly recommend you send the `merchantOrderReference` value to
+ benefit from linking payment requests when authorisation retries take
+ place. In addition, we recommend you provide `retry.orderAttemptNumber`,
+ `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
+ type: string
+ metadata:
+ x-addedInVersion: '17'
+ additionalProperties:
+ type: string
+ description: 'Metadata consists of entries, each of which includes a key
+ and a value.
+
+ Limits:
+
+ * Maximum 20 key-value pairs per request. When exceeding, the "177" error
+ occurs: "Metadata size exceeds limit".
+
+ * Maximum 20 characters per key.
+
+ * Maximum 80 characters per value. '
+ type: object
+ orderReference:
+ description: When you are doing multiple partial (gift card) payments, this
+ is the `pspReference` of the first payment. We use this to link the multiple
+ payments to each other. As your own reference for linking multiple payments,
+ use the `merchantOrderReference`instead.
+ type: string
+ origin:
+ description: 'Required for the Web integration.
+
+
+ Set this parameter to the origin URL of the page that you are loading
+ the SDK from.'
+ type: string
+ platformChargebackLogic:
+ x-addedInVersion: '68'
+ description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
+ $ref: '#/components/schemas/PlatformChargebackLogic'
+ recurringExpiry:
+ description: Date after which no further authorisations shall be performed.
+ Only for 3D Secure 2.
+ type: string
+ recurringFrequency:
+ description: Minimum number of days between authorisations. Only for 3D
+ Secure 2.
+ type: string
+ reference:
+ description: 'The reference to uniquely identify a payment. This reference
+ is used in all communication with you about the payment status. We recommend
+ using a unique value per payment; however, it is not a requirement.
+
+ If you need to provide multiple references for a transaction, separate
+ them with hyphens ("-").
+
+ Maximum length: 80 characters.'
+ type: string
+ returnUrl:
+ description: 'The URL to return to in case of a redirection.
+
+ The format depends on the channel. This URL can have a maximum of 1024
+ characters.
+
+ * For web, include the protocol `http://` or `https://`. You can also
+ include your own additional query parameters, for example, shopper ID
+ or order reference number.
+
+ Example: `https://your-company.com/checkout?shopperOrder=12xy`
+
+ * For iOS, use the custom URL for your app. To know more about setting
+ custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).
+
+ Example: `my-app://`
+
+ * For Android, use a custom URL handled by an Activity on your app. You
+ can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).
+
+ Example: `my-app://your.package.name`'
+ maxLength: 8000
+ type: string
+ riskData:
+ description: Contains risk data, such as client-side data, used to identify
+ risk for a transaction.
+ $ref: '#/components/schemas/RiskData'
+ sdkVersion:
+ x-addedInVersion: '32'
+ description: The version of the SDK you are using (for Web SDK integrations
+ only).
+ type: string
+ sessionValidity:
+ description: 'The date and time until when the session remains valid, in
+ [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
+
+
+ For example: 2020-07-18T15:42:40.428+01:00'
+ type: string
+ shopperEmail:
+ description: 'The shopper''s email address. We recommend that you provide
+ this data, as it is used in velocity fraud checks.
+
+ > For 3D Secure 2 transactions, schemes require `shopperEmail` for all
+ browser-based and mobile implementations.'
+ type: string
+ shopperIP:
+ description: 'The shopper''s IP address. In general, we recommend that you
+ provide this data, as it is used in a number of risk checks (for instance,
+ number of payment attempts or location-based checks).
+
+ > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based
+ implementations.
+
+ This field is also mandatory for some merchants depending on your business
+ model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
+ type: string
+ shopperInteraction:
+ description: 'Specifies the sales channel, through which the shopper gives
+ their card details, and whether the shopper is a returning customer.
+
+ For the web service API, Adyen assumes Ecommerce shopper interaction by
+ default.
+
+
+ This field has the following possible values:
+
+ * `Ecommerce` - Online transactions where the cardholder is present (online).
+ For better authorisation rates, we recommend sending the card security
+ code (CSC) along with the request.
+
+ * `ContAuth` - Card on file and/or subscription transactions, where the
+ cardholder is known to the merchant (returning customer). If the shopper
+ is present (online), you can supply also the CSC to improve authorisation
+ (one-click payment).
+
+ * `Moto` - Mail-order and telephone-order transactions where the shopper
+ is in contact with the merchant via email or telephone.
+
+ * `POS` - Point-of-sale transactions where the shopper is physically present
+ to make a payment using a secure payment terminal.'
+ enum:
+ - Ecommerce
+ - ContAuth
+ - Moto
+ - POS
+ type: string
+ shopperLocale:
+ x-addedInVersion: '7'
+ description: The combination of a language code and a country code to specify
+ the language to be used in the payment.
+ type: string
+ shopperName:
+ x-addedInVersion: '7'
+ description: The shopper's full name.
+ $ref: '#/components/schemas/Name'
+ shopperReference:
+ description: "Required for recurring payments. \nYour reference to uniquely\
+ \ identify this shopper, for example user ID or account ID. Minimum length:\
+ \ 3 characters.\n> Your reference must not include personally identifiable\
+ \ information (PII), for example name or email address."
+ type: string
+ shopperStatement:
+ description: "The text to be shown on the shopper's bank statement.\n We\
+ \ recommend sending a maximum of 22 characters, otherwise banks might\
+ \ truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**,\
+ \ spaces, and special characters **. , ' _ - ? + * /**."
+ type: string
+ socialSecurityNumber:
+ x-addedInVersion: '4'
+ description: The shopper's social security number.
+ type: string
+ splits:
+ x-addedInVersion: '37'
+ description: An array of objects specifying how the payment should be split
+ when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)
+ or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
+ items:
+ $ref: '#/components/schemas/Split'
+ type: array
+ store:
+ x-addedInVersion: '23'
+ description: Required for Adyen for Platforms integrations if you have a
+ platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference)
+ (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments))
+ or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference)
+ (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store))
+ for the ecommerce or point-of-sale store that is processing the payment.
+ maxLength: 16
+ minLength: 1
+ type: string
+ storePaymentMethod:
+ x-addedInVersion: '49'
+ description: When true and `shopperReference` is provided, the payment details
+ will be stored.
+ type: boolean
+ telephoneNumber:
+ x-addedInVersion: '7'
+ description: The shopper's telephone number.
+ type: string
+ threeDSAuthenticationOnly:
+ x-addedInVersion: '50'
+ deprecated: true
+ x-deprecatedInVersion: '69'
+ x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ token:
+ description: 'The token obtained when initializing the SDK.
+
+
+ > This parameter is required for iOS and Android; not required for Web.'
+ type: string
+ trustedShopper:
+ x-addedInVersion: '37'
+ description: Set to true if the payment should be routed to a trusted MID.
+ type: boolean
+ required:
+ - merchantAccount
+ - reference
+ - amount
+ - returnUrl
+ - countryCode
+ type: object
+ PaymentSetupResponse:
+ properties:
+ paymentSession:
+ description: The encoded payment session that you need to pass to the SDK.
+ type: string
+ recurringDetails:
+ deprecated: true
+ description: The detailed list of stored payment details required to generate
+ payment forms. Will be empty if oneClick is set to false in the request.
+ items:
+ $ref: '#/components/schemas/RecurringDetail'
+ type: array
+ type: object
+ PaymentVerificationRequest:
+ properties:
+ payload:
+ description: Encrypted and signed payment result data. You should receive
+ this value from the Checkout SDK after the shopper completes the payment.
+ maxLength: 40000
+ type: string
+ required:
+ - payload
+ type: object
+ PaymentVerificationResponse:
+ properties:
+ additionalData:
+ additionalProperties:
+ type: string
+ x-anyOf:
+ - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
+ - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCard'
+ - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
+ - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
+ - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
+ - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
+ - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
+ - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
+ description: 'Contains additional information about the payment. Some data
+ fields are included only if you select them first: Go to **Customer Area**
+ > **Developers** > **Additional data**.'
+ type: object
+ fraudResult:
+ description: The fraud result properties of the payment.
+ $ref: '#/components/schemas/FraudResult'
+ merchantReference:
+ description: A unique value that you provided in the initial `/paymentSession`
+ request as a `reference` field.
+ type: string
+ order:
+ description: Contains updated information regarding the order in case order
+ information was provided in the request.
+ $ref: '#/components/schemas/CheckoutOrderResponse'
+ pspReference:
+ description: Adyen's 16-character reference associated with the transaction/request.
+ This value is globally unique; quote it when communicating with us about
+ this request.
+ type: string
+ refusalReason:
+ description: 'If the payment''s authorisation is refused or an error occurs
+ during authorisation, this field holds Adyen''s mapped reason for the
+ refusal or a description of the error. When a transaction fails, the authorisation
+ response includes `resultCode` and `refusalReason` values.
+
+
+ For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
+ type: string
+ refusalReasonCode:
+ x-addedInVersion: '37'
+ description: Code that specifies the refusal reason. For more information,
+ see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
+ type: string
+ resultCode:
+ description: "The result of the payment. For more information, see [Result\
+ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\
+ \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\
+ \ has been successfully authenticated with 3D Secure 2. Returned for 3D\
+ \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\
+ \ \u2013 The transaction does not require 3D Secure authentication. Returned\
+ \ for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n\
+ * **Authorised** \u2013 The payment was successfully authorised. This\
+ \ state serves as an indicator to proceed with the delivery of goods and\
+ \ services. This is a final state.\n* **Cancelled** \u2013 Indicates the\
+ \ payment has been cancelled (either by the shopper or the merchant) before\
+ \ processing was completed. This is a final state.\n* **ChallengeShopper**\
+ \ \u2013 The issuer requires further shopper interaction before the payment\
+ \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\
+ \ \u2013 There was an error when the payment was being processed. The\
+ \ reason is given in the `refusalReason` field. This is a final state.\n\
+ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\
+ \ fingerprint before the payment can be authenticated. Returned for 3D\
+ \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\
+ \ has been authorised for a partial amount.\nThis happens for card payments\
+ \ when the merchant supports Partial Authorisations and the cardholder\
+ \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\
+ \ possible to obtain the final status of the payment. This can happen\
+ \ if the systems providing final status information for the payment are\
+ \ unavailable, or if the shopper needs to take further action to complete\
+ \ the payment.\n* **PresentToShopper** \u2013 Indicates that the response\
+ \ contains additional information that you need to present to a shopper,\
+ \ so that they can use it to complete a payment.\n* **Received** \u2013\
+ \ Indicates the payment has successfully been received by Adyen, and will\
+ \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\
+ \ \u2013 Indicates the shopper should be redirected to an external web\
+ \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\
+ \ the payment was refused. The reason is given in the `refusalReason`\
+ \ field. This is a final state."
+ enum:
+ - AuthenticationFinished
+ - AuthenticationNotRequired
+ - Authorised
+ - Cancelled
+ - ChallengeShopper
+ - Error
+ - IdentifyShopper
+ - PartiallyAuthorised
+ - Pending
+ - PresentToShopper
+ - Received
+ - RedirectShopper
+ - Refused
+ - Success
+ type: string
+ serviceError:
+ description: The type of the error.
+ $ref: '#/components/schemas/ServiceErrorDetails'
+ shopperLocale:
+ description: The shopperLocale value provided in the payment request.
+ type: string
+ required:
+ - merchantReference
+ - shopperLocale
+ type: object
+ Phone:
+ properties:
+ cc:
+ description: "Country code. Length: 1\u20133 characters."
+ maxLength: 3
+ minLength: 1
+ type: string
+ subscriber:
+ description: 'Subscriber number. Maximum length: 15 characters.'
+ maxLength: 15
+ type: string
+ type: object
+ PlatformChargebackLogic:
+ properties:
+ behavior:
+ x-addedInVersion: '68'
+ description: 'The method of handling the chargeback.
+
+
+ Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**,
+ **deductAccordingToSplitRatio**.'
+ enum:
+ - deductAccordingToSplitRatio
+ - deductFromLiableAccount
+ - deductFromOneBalanceAccount
+ type: string
+ costAllocationAccount:
+ x-addedInVersion: '68'
+ description: The unique identifier of the balance account to which the chargeback
+ fees are booked. By default, the chargeback fees are booked to your liable
+ balance account.
+ type: string
+ targetAccount:
+ x-addedInVersion: '68'
+ description: 'The unique identifier of the balance account against which
+ the disputed amount is booked.
+
+
+ Required if `behavior` is **deductFromOneBalanceAccount**.'
+ type: string
+ type: object
+ RatepayDetails:
+ additionalProperties: false
+ properties:
+ billingAddress:
+ description: The address where to send the invoice.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ deliveryAddress:
+ description: The address where the goods should be delivered.
+ type: string
+ personalDetails:
+ description: Shopper name, date of birth, phone number, and email address.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: ratepay
+ description: '**ratepay**'
+ enum:
+ - ratepay
+ - ratepay_directdebit
+ type: string
+ required:
+ - type
+ title: Ratepay
+ type: object
+ Recurring:
+ properties:
+ contract:
+ description: "The type of recurring contract to be used.\nPossible values:\n\
+ * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\
+ \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\
+ * `RECURRING` \u2013 Payment details can be used without the card security\
+ \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\
+ * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\
+ \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\
+ \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)."
+ enum:
+ - ONECLICK
+ - RECURRING
+ - PAYOUT
+ type: string
+ recurringDetailName:
+ description: A descriptive name for this detail.
+ type: string
+ recurringExpiry:
+ x-addedInVersion: '40'
+ description: Date after which no further authorisations shall be performed.
+ Only for 3D Secure 2.
+ format: date-time
+ type: string
+ recurringFrequency:
+ x-addedInVersion: '40'
+ description: Minimum number of days between authorisations. Only for 3D
+ Secure 2.
+ type: string
+ tokenService:
+ x-addedInVersion: '25'
+ description: The name of the token service.
+ enum:
+ - VISATOKENSERVICE
+ - MCTOKENSERVICE
+ - AMEXTOKENSERVICE
+ - TOKEN_SHARING
+ type: string
+ type: object
+ RecurringDetail:
+ properties:
+ brand:
+ x-addedInVersion: '65'
+ description: 'Brand for the selected gift card. For example: plastix, hmclub.'
+ type: string
+ brands:
+ x-addedInVersion: '49'
+ description: 'List of possible brands. For example: visa, mc.'
+ items:
+ type: string
+ type: array
+ configuration:
+ additionalProperties:
+ type: string
+ description: The configuration of the payment method.
+ type: object
+ fundingSource:
+ x-addedInVersion: '53'
+ description: The funding source of the payment method.
+ enum:
+ - credit
+ - debit
+ type: string
+ group:
+ description: The group where this payment method belongs to.
+ $ref: '#/components/schemas/PaymentMethodGroup'
+ inputDetails:
+ deprecated: true
+ description: All input details to be provided to complete the payment with
+ this payment method.
+ items:
+ $ref: '#/components/schemas/InputDetail'
+ type: array
+ issuers:
+ x-addedInVersion: '68'
+ description: A list of issuers for this payment method.
+ items:
+ $ref: '#/components/schemas/PaymentMethodIssuer'
+ type: array
+ name:
+ description: The displayable name of this payment method.
+ type: string
+ recurringDetailReference:
+ description: The reference that uniquely identifies the recurring detail.
+ type: string
+ storedDetails:
+ description: Contains information on previously stored payment details.
+ $ref: '#/components/schemas/StoredDetails'
+ type:
+ description: The unique payment method code.
+ type: string
+ type: object
+ ResponseAdditionalData3DSecure:
+ properties:
+ cardHolderInfo:
+ description: 'Information provided by the issuer to the cardholder. If this
+ field is present, you need to display this information to the cardholder. '
+ type: string
+ cavv:
+ description: The Cardholder Authentication Verification Value (CAVV) for
+ the 3D Secure authentication session, as a Base64-encoded 20-byte array.
+ type: string
+ cavvAlgorithm:
+ description: The CAVV algorithm used.
+ type: string
+ scaExemptionRequested:
+ description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\
+ \ that Adyen requested for the payment.\n\n Possible values:\n* **lowValue**\
+ \ \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
+ type: string
+ threeds2.cardEnrolled:
+ description: Indicates whether a card is enrolled for 3D Secure 2.
+ type: boolean
+ type: object
+ ResponseAdditionalDataBillingAddress:
+ properties:
+ billingAddress.city:
+ description: The billing address city passed in the payment request.
+ type: string
+ billingAddress.country:
+ description: 'The billing address country passed in the payment request.
+
+
+ Example: NL'
+ type: string
+ billingAddress.houseNumberOrName:
+ description: The billing address house number or name passed in the payment
+ request.
+ type: string
+ billingAddress.postalCode:
+ description: 'The billing address postal code passed in the payment request.
+
+
+ Example: 1011 DJ'
+ type: string
+ billingAddress.stateOrProvince:
+ description: 'The billing address state or province passed in the payment
+ request.
+
+
+ Example: NH'
+ type: string
+ billingAddress.street:
+ description: The billing address street passed in the payment request.
+ type: string
+ type: object
+ ResponseAdditionalDataCard:
+ properties:
+ cardBin:
+ description: 'The first six digits of the card number.
+
+
+ This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin)
+ for card numbers with a six-digit BIN.
+
+
+ Example: 521234'
+ type: string
+ cardHolderName:
+ description: The cardholder name passed in the payment request.
+ type: string
+ cardIssuingBank:
+ description: The bank or the financial institution granting lines of credit
+ through card association branded payment cards. This information can be
+ included when available.
+ type: string
+ cardIssuingCountry:
+ description: 'The country where the card was issued.
+
+
+ Example: US'
+ type: string
+ cardIssuingCurrency:
+ description: "The currency in which the card is issued, if this information\
+ \ is available. Provided as the currency code or currency number from\
+ \ the ISO-4217 standard. \n\nExample: USD"
+ type: string
+ cardPaymentMethod:
+ description: 'The card payment method used for the transaction.
+
+
+ Example: amex'
+ type: string
+ cardSummary:
+ description: 'The last four digits of a card number.
+
+
+ > Returned only in case of a card payment.'
+ type: string
+ issuerBin:
+ description: 'The first eight digits of the card number. Only returned if
+ the card number is 16 digits or more.
+
+
+ This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin)
+ for card numbers with an eight-digit BIN.
+
+
+ Example: 52123423'
+ type: string
+ type: object
+ ResponseAdditionalDataCommon:
+ properties:
+ acquirerAccountCode:
+ description: 'The name of the Adyen acquirer account.
+
+
+ Example: PayPalSandbox_TestAcquirer
+
+
+ > Only relevant for PayPal transactions.'
+ type: string
+ acquirerCode:
+ description: 'The name of the acquirer processing the payment request.
+
+
+ Example: TestPmmAcquirer'
+ type: string
+ acquirerReference:
+ description: 'The reference number that can be used for reconciliation in
+ case a non-Adyen acquirer is used for settlement.
+
+
+ Example: 7C9N3FNBKT9'
+ type: string
+ alias:
+ description: 'The Adyen alias of the card.
+
+
+ Example: H167852639363479'
+ type: string
+ aliasType:
+ description: 'The type of the card alias.
+
+
+ Example: Default'
+ type: string
+ authCode:
+ description: 'Authorisation code:
+
+ * When the payment is authorised successfully, this field holds the authorisation
+ code for the payment.
+
+ * When the payment is not authorised, this field is empty.
+
+
+ Example: 58747'
+ type: string
+ authorisationMid:
+ description: Merchant ID known by the acquirer.
+ type: string
+ authorisedAmountCurrency:
+ description: The currency of the authorised amount, as a three-character
+ [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ type: string
+ authorisedAmountValue:
+ description: 'Value of the amount authorised.
+
+
+ This amount is represented in minor units according to the [following
+ table](https://docs.adyen.com/development-resources/currency-codes).'
+ type: string
+ avsResult:
+ description: 'The AVS result code of the payment, which provides information
+ about the outcome of the AVS check.
+
+
+ For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).'
+ type: string
+ avsResultRaw:
+ description: 'Raw AVS result received from the acquirer, where available.
+
+
+ Example: D'
+ type: string
+ bic:
+ description: 'BIC of a bank account.
+
+
+ Example: TESTNL01
+
+
+ > Only relevant for SEPA Direct Debit transactions.'
+ type: string
+ coBrandedWith:
+ description: Includes the co-branded card information.
+ type: string
+ cvcResult:
+ description: The result of CVC verification.
+ example: 1 Matches
+ type: string
+ cvcResultRaw:
+ description: The raw result of CVC verification.
+ example: M
+ type: string
+ dsTransID:
+ description: Supported for 3D Secure 2. The unique transaction identifier
+ assigned by the DS to identify a single transaction.
+ type: string
+ eci:
+ description: 'The Electronic Commerce Indicator returned from the schemes
+ for the 3DS payment session.
+
+
+ Example: 02'
+ type: string
+ expiryDate:
+ description: 'The expiry date on the card.
+
+
+ Example: 6/2016
+
+
+ > Returned only in case of a card payment.'
+ type: string
+ extraCostsCurrency:
+ description: 'The currency of the extra amount charged due to additional
+ amounts set in the skin used in the HPP payment request.
+
+
+ Example: EUR'
+ type: string
+ extraCostsValue:
+ description: The value of the extra amount charged due to additional amounts
+ set in the skin used in the HPP payment request. The amount is in minor
+ units.
+ type: string
+ fraudCheck-[itemNr]-[FraudCheckname]:
+ description: The fraud score due to a particular fraud check. The fraud
+ check name is found in the key of the key-value pair.
+ type: string
+ fraudManualReview:
+ description: Indicates if the payment is sent to manual review.
+ type: string
+ fraudResultType:
+ description: The fraud result properties of the payment.
+ enum:
+ - GREEN
+ - FRAUD
+ type: string
+ fundingSource:
+ description: 'Information regarding the funding type of the card. The possible
+ return values are:
+
+ * CHARGE
+
+ * CREDIT
+
+ * DEBIT
+
+ * PREPAID
+
+ * PREPAID_RELOADABLE
+
+
+ * PREPAID_NONRELOADABLE
+
+ * DEFFERED_DEBIT
+
+
+ > This functionality requires additional configuration on Adyen''s end.
+ To enable it, contact the Support Team.
+
+
+ For receiving this field in the notification, enable **Include Funding
+ Source** in **Notifications** > **Additional settings**.'
+ type: string
+ fundsAvailability:
+ description: 'Indicates availability of funds.
+
+
+ Visa:
+
+ * "I" (fast funds are supported)
+
+ * "N" (otherwise)
+
+
+ Mastercard:
+
+ * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM
+ list)
+
+ * "N" (otherwise)
+
+
+ > Returned when you verify a card BIN or estimate costs, and only if payoutEligible
+ is "Y" or "D".'
+ type: string
+ inferredRefusalReason:
+ description: 'Provides the more granular indication of why a transaction
+ was refused. When a transaction fails with either "Refused", "Restricted
+ Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic"
+ refusalReason from the issuer, Adyen cross references its PSP-wide data
+ for extra insight into the refusal reason. If an inferred refusal reason
+ is available, the `inferredRefusalReason`, field is populated and the
+ `refusalReason`, is set to "Not Supported".
+
+
+ Possible values:
+
+
+ * 3D Secure Mandated
+
+ * Closed Account
+
+ * ContAuth Not Supported
+
+ * CVC Mandated
+
+ * Ecommerce Not Allowed
+
+ * Crossborder Not Supported
+
+ * Card Updated
+
+
+ * Low Authrate Bin
+
+ * Non-reloadable prepaid card'
+ type: string
+ isCardCommercial:
+ description: Indicates if the card is used for business purposes only.
+ type: string
+ issuerCountry:
+ description: 'The issuing country of the card based on the BIN list that
+ Adyen maintains.
+
+
+ Example: JP'
+ type: string
+ liabilityShift:
+ description: A Boolean value indicating whether a liability shift was offered
+ for this payment.
+ type: string
+ mcBankNetReferenceNumber:
+ description: 'The `mcBankNetReferenceNumber`, is a minimum of six characters
+ and a maximum of nine characters long.
+
+
+ > Contact Support Team to enable this field.'
+ type: string
+ merchantAdviceCode:
+ description: 'The Merchant Advice Code (MAC) can be returned by Mastercard
+ issuers for refused payments. If present, the MAC contains information
+ about why the payment failed, and whether it can be retried.
+
+
+ For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).'
+ type: string
+ merchantReference:
+ description: The reference provided for the transaction.
+ type: string
+ networkTxReference:
+ description: 'Returned in the response if you are not tokenizing with Adyen
+ and are using the Merchant-initiated transactions (MIT) framework from
+ Mastercard or Visa.
+
+
+ This contains either the Mastercard Trace ID or the Visa Transaction ID.'
+ type: string
+ ownerName:
+ description: 'The owner name of a bank account.
+
+
+ Only relevant for SEPA Direct Debit transactions.'
+ type: string
+ paymentAccountReference:
+ description: The Payment Account Reference (PAR) value links a network token
+ with the underlying primary account number (PAN). The PAR value consists
+ of 29 uppercase alphanumeric characters.
+ type: string
+ paymentMethod:
+ description: The payment method used in the transaction.
+ type: string
+ paymentMethodVariant:
+ description: 'The Adyen sub-variant of the payment method used for the payment
+ request.
+
+
+ For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).
+
+
+ Example: mcpro'
+ type: string
+ payoutEligible:
+ description: 'Indicates whether a payout is eligible or not for this card.
+
+
+ Visa:
+
+ * "Y"
+
+ * "N"
+
+
+ Mastercard:
+
+ * "Y" (domestic and cross-border)
+
+
+ * "D" (only domestic)
+
+ * "N" (no MoneySend)
+
+ * "U" (unknown)'
+ type: string
+ realtimeAccountUpdaterStatus:
+ description: 'The response code from the Real Time Account Updater service.
+
+
+ Possible return values are:
+
+ * CardChanged
+
+ * CardExpiryChanged
+
+ * CloseAccount
+
+
+ * ContactCardAccountHolder'
+ type: string
+ receiptFreeText:
+ description: Message to be displayed on the terminal.
+ type: string
+ recurring.contractTypes:
+ x-addedInVersion: '40'
+ description: The recurring contract types applicable to the transaction.
+ type: string
+ recurring.firstPspReference:
+ description: 'The `pspReference`, of the first recurring payment that created
+ the recurring detail.
+
+
+ This functionality requires additional configuration on Adyen''s end.
+ To enable it, contact the Support Team.'
+ type: string
+ recurring.recurringDetailReference:
+ description: The reference that uniquely identifies the recurring transaction.
+ type: string
+ recurring.shopperReference:
+ x-addedInVersion: '40'
+ description: The provided reference of the shopper for a recurring transaction.
+ type: string
+ recurringProcessingModel:
+ x-addedInVersion: '40'
+ description: The processing model used for the recurring transaction.
+ enum:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: string
+ referred:
+ description: 'If the payment is referred, this field is set to true.
+
+
+ This field is unavailable if the payment is referred and is usually not
+ returned with ecommerce transactions.
+
+
+ Example: true'
+ type: string
+ refusalReasonRaw:
+ description: 'Raw refusal reason received from the acquirer, where available.
+
+
+ Example: AUTHORISED'
+ type: string
+ requestAmount:
+ description: The amount of the payment request.
+ type: string
+ requestCurrencyCode:
+ description: The currency of the payment request.
+ type: string
+ shopperInteraction:
+ description: 'The shopper interaction type of the payment request.
+
+
+ Example: Ecommerce'
+ type: string
+ shopperReference:
+ description: 'The shopperReference passed in the payment request.
+
+
+ Example: AdyenTestShopperXX'
+ type: string
+ terminalId:
+ description: 'The terminal ID used in a point-of-sale payment.
+
+
+ Example: 06022622'
+ type: string
+ threeDAuthenticated:
+ description: 'A Boolean value indicating whether 3DS authentication was
+ completed on this payment.
+
+
+ Example: true'
+ type: string
+ threeDAuthenticatedResponse:
+ description: 'The raw 3DS authentication result from the card issuer.
+
+
+ Example: N'
+ type: string
+ threeDOffered:
+ description: 'A Boolean value indicating whether 3DS was offered for this
+ payment.
+
+
+ Example: true'
+ type: string
+ threeDOfferedResponse:
+ description: 'The raw enrollment result from the 3DS directory services
+ of the card schemes.
+
+
+ Example: Y'
+ type: string
+ threeDSVersion:
+ description: The 3D Secure 2 version.
+ type: string
+ visaTransactionId:
+ description: 'The `visaTransactionId`, has a fixed length of 15 numeric
+ characters.
+
+
+ > Contact Support Team to enable this field.'
+ type: string
+ xid:
+ description: 'The 3DS transaction ID of the 3DS session sent in notifications.
+ The value is Base64-encoded and is returned for transactions with directoryResponse
+ ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request,
+ use the `mpiData.xid`, field.
+
+
+ Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
+ type: string
+ type: object
+ ResponseAdditionalDataDomesticError:
+ properties:
+ domesticRefusalReasonRaw:
+ description: "The reason the transaction was declined, given by the local\
+ \ issuer. \nCurrently available for merchants in Japan."
+ type: string
+ domesticShopperAdvice:
+ description: "The action the shopper should take, in a local language. \n\
+ Currently available in Japanese, for merchants in Japan."
+ type: string
+ type: object
+ ResponseAdditionalDataInstallments:
+ properties:
+ installmentPaymentData.installmentType:
+ description: Type of installment. The value of `installmentType` should
+ be **IssuerFinanced**.
+ type: string
+ installmentPaymentData.option[itemNr].annualPercentageRate:
+ description: Annual interest rate.
+ type: string
+ installmentPaymentData.option[itemNr].firstInstallmentAmount:
+ description: First Installment Amount in minor units.
+ type: string
+ installmentPaymentData.option[itemNr].installmentFee:
+ description: Installment fee amount in minor units.
+ type: string
+ installmentPaymentData.option[itemNr].interestRate:
+ description: Interest rate for the installment period.
+ type: string
+ installmentPaymentData.option[itemNr].maximumNumberOfInstallments:
+ description: Maximum number of installments possible for this payment.
+ type: string
+ installmentPaymentData.option[itemNr].minimumNumberOfInstallments:
+ description: Minimum number of installments possible for this payment.
+ type: string
+ installmentPaymentData.option[itemNr].numberOfInstallments:
+ description: Total number of installments possible for this payment.
+ type: string
+ installmentPaymentData.option[itemNr].subsequentInstallmentAmount:
+ description: Subsequent Installment Amount in minor units.
+ type: string
+ installmentPaymentData.option[itemNr].totalAmountDue:
+ description: Total amount in minor units.
+ type: string
+ installmentPaymentData.paymentOptions:
+ description: 'Possible values:
+
+ * PayInInstallmentsOnly
+
+ * PayInFullOnly
+
+ * PayInFullOrInstallments'
+ type: string
+ installments.value:
+ description: 'The number of installments that the payment amount should
+ be charged with.
+
+
+ Example: 5
+
+ > Only relevant for card payments in countries that support installments.'
+ type: string
+ type: object
+ ResponseAdditionalDataNetworkTokens:
+ properties:
+ networkToken.available:
+ description: Indicates whether a network token is available for the specified
+ card.
+ type: string
+ networkToken.bin:
+ description: The Bank Identification Number of a tokenized card, which is
+ the first six digits of a card number.
+ type: string
+ networkToken.tokenSummary:
+ description: The last four digits of a network token.
+ type: string
+ type: object
+ ResponseAdditionalDataOpi:
+ properties:
+ opi.transToken:
+ description: 'Returned in the response if you included `opi.includeTransToken:
+ true` in an ecommerce payment request. This contains an Oracle Payment
+ Interface token that you can store in your Oracle Opera database to identify
+ tokenized ecommerce transactions. For more information and required settings,
+ see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
+ type: string
+ type: object
+ ResponseAdditionalDataSepa:
+ properties:
+ sepadirectdebit.dateOfSignature:
+ description: 'The transaction signature date.
+
+
+ Format: yyyy-MM-dd'
+ type: string
+ sepadirectdebit.mandateId:
+ description: Its value corresponds to the pspReference value of the transaction.
+ type: string
+ sepadirectdebit.sequenceType:
+ description: 'This field can take one of the following values:
+
+ * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct
+ debit transaction.
+
+
+ * First: (FRST) Initial/first collection in a series of direct debit instructions.
+
+ * Recurring: (RCUR) Direct debit instruction to carry out regular direct
+ debit transactions initiated by the creditor.
+
+ * Final: (FNAL) Last/final collection in a series of direct debit instructions.
+
+
+ Example: OOFF'
+ type: string
+ type: object
+ ResponsePaymentMethod:
+ properties:
+ brand:
+ description: The card brand that the shopper used to pay. Only returned
+ if `paymentMethod.type` is **scheme**.
+ type: string
+ type:
+ description: The `paymentMethod.type` value used in the request.
+ type: string
+ title: paymentResponse
+ type: object
+ RiskData:
+ properties:
+ clientData:
+ description: Contains client-side data, like the device fingerprint, cookies,
+ and specific browser settings.
+ type: string
+ customFields:
+ x-addedInVersion: '65'
+ additionalProperties:
+ type: string
+ description: Any custom fields used as part of the input to configured risk
+ rules.
+ type: object
+ fraudOffset:
+ x-addedInVersion: '65'
+ description: An integer value that is added to the normal fraud score. The
+ value can be either positive or negative.
+ format: int32
+ type: integer
+ profileReference:
+ x-addedInVersion: '65'
+ description: The risk profile to assign to this payment. When left empty,
+ the merchant-level account's default risk profile will be applied.
+ type: string
+ type: object
+ SDKEphemPubKey:
+ properties:
+ crv:
+ description: The `crv` value as received from the 3D Secure 2 SDK.
+ type: string
+ kty:
+ description: The `kty` value as received from the 3D Secure 2 SDK.
+ type: string
+ x:
+ description: The `x` value as received from the 3D Secure 2 SDK.
+ type: string
+ y:
+ description: The `y` value as received from the 3D Secure 2 SDK.
+ type: string
+ type: object
+ SamsungPayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ samsungPayToken:
+ description: The payload you received from the Samsung Pay SDK response.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: samsungpay
+ description: '**samsungpay**'
+ enum:
+ - samsungpay
+ type: string
+ required:
+ - samsungPayToken
+ title: Samsung Pay
+ type: object
+ SepaDirectDebitDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ iban:
+ description: The International Bank Account Number (IBAN).
+ type: string
+ ownerName:
+ description: The name of the bank account holder.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: sepadirectdebit
+ description: '**sepadirectdebit**'
+ enum:
+ - sepadirectdebit
+ - sepadirectdebit_amazonpay
+ type: string
+ required:
+ - iban
+ - ownerName
+ title: SEPA Direct Debit
+ type: object
+ ServiceError:
+ properties:
+ additionalData:
+ x-addedInVersion: '46'
+ additionalProperties:
+ type: string
+ description: Contains additional information about the payment. Some data
+ fields are included only if you select them first. Go to **Customer Area**
+ > **Developers** > **Additional data**.
+ type: object
+ errorCode:
+ description: The error code mapped to the error message.
+ type: string
+ errorType:
+ description: The category of the error.
+ type: string
+ message:
+ description: A short explanation of the issue.
+ type: string
+ pspReference:
+ description: The PSP reference of the payment.
+ type: string
+ status:
+ description: The HTTP response status.
+ format: int32
+ type: integer
+ type: object
+ ServiceErrorDetails:
+ properties:
+ errorCode:
+ type: string
+ errorType:
+ type: string
+ message:
+ type: string
+ pspReference:
+ type: string
+ type: object
+ SessionResultResponse:
+ properties:
+ id:
+ description: A unique identifier of the session.
+ type: string
+ status:
+ description: "The status of the session. The status included in the response\
+ \ doesn't get updated. Don't make the request again to check for payment\
+ \ status updates.\n\nPossible values:\n\n * **completed** \u2013\
+ \ The shopper completed the payment. This means that the payment was authorized.\n\
+ \ * **paymentPending** \u2013 The shopper is in the process of\
+ \ making the payment. This applies to payment methods with an asynchronous\
+ \ flow.\n * **refused** \u2013 The session has been refused, due\
+ \ to too many refused payment attempts. Shoppers can no longer complete\
+ \ the payment with this session.\n * **canceled** \u2013 The shopper\
+ \ canceled the payment.\n * **active** \u2013 The session is still\
+ \ active and can be paid.\n * **expired** \u2013 The session expired\
+ \ (default: 1 hour after session creation). Shoppers can no longer complete\
+ \ the payment with this session.\n"
+ enum:
+ - active
+ - canceled
+ - completed
+ - expired
+ - paymentPending
+ - refused
+ type: string
+ type: object
+ ShopperInput:
+ properties:
+ billingAddress:
+ description: 'Specifies visibility of billing address fields.
+
+
+ Permitted values:
+
+ * editable
+
+ * hidden
+
+ * readOnly'
+ enum:
+ - editable
+ - hidden
+ - readOnly
+ type: string
+ deliveryAddress:
+ description: 'Specifies visibility of delivery address fields.
+
+
+ Permitted values:
+
+ * editable
+
+ * hidden
+
+ * readOnly'
+ enum:
+ - editable
+ - hidden
+ - readOnly
+ type: string
+ personalDetails:
+ description: 'Specifies visibility of personal details.
+
+
+ Permitted values:
+
+ * editable
+
+ * hidden
+
+ * readOnly'
+ enum:
+ - editable
+ - hidden
+ - readOnly
+ type: string
+ type: object
+ ShopperInteractionDevice:
+ properties:
+ locale:
+ description: Locale on the shopper interaction device.
+ type: string
+ os:
+ description: Operating system running on the shopper interaction device.
+ type: string
+ osVersion:
+ description: Version of the operating system on the shopper interaction
+ device.
+ type: string
+ type: object
+ Split:
+ properties:
+ account:
+ description: 'The unique identifier of the account to which the split amount
+ is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.
+
+
+ * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
+ The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode)
+ of the account to which the split amount is booked.
+
+ * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
+ The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id)
+ of the account to which the split amount is booked.'
+ type: string
+ amount:
+ description: 'The amount of the split item.
+
+
+ * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).
+
+ * Required if `type` is **BalanceAccount**, **Commission**, **Default**,
+ or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)
+ integration.'
+ $ref: '#/components/schemas/SplitAmount'
+ description:
+ description: Your description for the split item.
+ type: string
+ reference:
+ description: 'Your unique reference for the split item.
+
+
+ This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic))
+ or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).
+
+
+ For the other types, we also recommend providing a **unique** reference
+ so you can reconcile the split and the associated payment in the transaction
+ overview and in the reports.'
+ type: string
+ type:
+ description: 'The type of the split item.
+
+
+ Possible values:
+
+
+ * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic):
+ **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.
+
+ * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms):
+ **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**,
+ **Surcharge**, **Tip**, **VAT**.'
+ enum:
+ - AcquiringFees
+ - AdyenCommission
+ - AdyenFees
+ - AdyenMarkup
+ - BalanceAccount
+ - Commission
+ - Default
+ - Interchange
+ - MarketPlace
+ - PaymentFee
+ - Remainder
+ - SchemeFee
+ - Surcharge
+ - Tip
+ - VAT
+ type: string
+ required:
+ - type
+ type: object
+ SplitAmount:
+ properties:
+ currency:
+ description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
+ By default, this is the original payment currency.
+ maxLength: 3
+ minLength: 3
+ type: string
+ value:
+ description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
+ format: int64
+ type: integer
+ required:
+ - value
+ type: object
+ StandalonePaymentCancelRequest:
+ properties:
+ applicationInfo:
+ description: Information about your application. For more details, see [Building
+ Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
+ $ref: '#/components/schemas/ApplicationInfo'
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentReference:
+ description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference)
+ of the payment that you want to cancel.
+ type: string
+ reference:
+ description: 'Your reference for the cancel request. Maximum length: 80
+ characters.'
+ type: string
+ required:
+ - merchantAccount
+ - paymentReference
+ type: object
+ StandalonePaymentCancelResponse:
+ properties:
+ merchantAccount:
+ description: The merchant account that is used to process the payment.
+ type: string
+ paymentReference:
+ description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference)
+ of the payment to cancel.
+ type: string
+ pspReference:
+ description: Adyen's 16-character reference associated with the cancel request.
+ type: string
+ reference:
+ description: Your reference for the cancel request.
+ type: string
+ status:
+ description: The status of your request. This will always have the value
+ **received**.
+ enum:
+ - received
+ type: string
+ required:
+ - status
+ - merchantAccount
+ - pspReference
+ - paymentReference
+ type: object
+ StoredDetails:
+ properties:
+ bank:
+ description: The stored bank account.
+ $ref: '#/components/schemas/BankAccount'
+ card:
+ description: The stored card information.
+ $ref: '#/components/schemas/Card'
+ emailAddress:
+ description: The email associated with stored payment details.
+ type: string
+ type: object
+ StoredPaymentMethod:
+ properties:
+ bankAccountNumber:
+ description: The bank account number (without separators).
+ type: string
+ bankLocationId:
+ description: The location id of the bank. The field value is `nil` in most
+ cases.
+ type: string
+ brand:
+ description: The brand of the card.
+ type: string
+ expiryMonth:
+ description: The month the card expires.
+ type: string
+ expiryYear:
+ description: The last two digits of the year the card expires. For example,
+ **22** for the year 2022.
+ type: string
+ holderName:
+ description: The unique payment method code.
+ type: string
+ iban:
+ x-addedInVersion: '67'
+ description: The IBAN of the bank account.
+ type: string
+ id:
+ description: A unique identifier of this stored payment method.
+ type: string
+ label:
+ x-addedInVersion: '70'
+ description: "The shopper\u2019s issuer account label"
+ type: string
+ lastFour:
+ description: The last four digits of the PAN.
+ type: string
+ name:
+ description: The display name of the stored payment method.
+ type: string
+ networkTxReference:
+ x-addedInVersion: '68'
+ description: 'Returned in the response if you are not tokenizing with Adyen
+ and are using the Merchant-initiated transactions (MIT) framework from
+ Mastercard or Visa.
+
+
+ This contains either the Mastercard Trace ID or the Visa Transaction ID.'
+ type: string
+ ownerName:
+ x-addedInVersion: '67'
+ description: The name of the bank account holder.
+ type: string
+ shopperEmail:
+ description: "The shopper\u2019s email address."
+ type: string
+ supportedRecurringProcessingModels:
+ x-addedInVersion: '70'
+ description: The supported recurring processing models for this stored payment
+ method.
+ items:
+ type: string
+ type: array
+ supportedShopperInteractions:
+ description: The supported shopper interactions for this stored payment
+ method.
+ items:
+ type: string
+ type: array
+ type:
+ description: The type of payment method.
+ type: string
+ type: object
+ StoredPaymentMethodDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ description: The payment method type.
+ enum:
+ - bcmc_mobile
+ - bcmc_mobile_QR
+ - bcmc_mobile_app
+ - momo_wallet
+ - momo_wallet_app
+ - twint
+ - paymaya_wallet
+ - grabpay_SG
+ - grabpay_MY
+ - grabpay_TH
+ - grabpay_ID
+ - grabpay_VN
+ - grabpay_PH
+ - oxxo
+ - gcash
+ - dana
+ - kakaopay
+ - truemoney
+ type: string
+ title: Stored Payment Method
+ type: object
+ StoredPaymentMethodResource:
+ properties:
+ brand:
+ description: The brand of the card.
+ type: string
+ expiryMonth:
+ description: The month the card expires.
+ type: string
+ expiryYear:
+ description: The last two digits of the year the card expires. For example,
+ **22** for the year 2022.
+ type: string
+ externalResponseCode:
+ x-addedInVersion: '68'
+ description: The response code returned by an external system (for example
+ after a provisioning operation).
+ type: string
+ externalTokenReference:
+ x-addedInVersion: '68'
+ description: The token reference of a linked token in an external system
+ (for example a network token reference).
+ type: string
+ holderName:
+ description: The unique payment method code.
+ type: string
+ iban:
+ description: The IBAN of the bank account.
+ type: string
+ id:
+ description: A unique identifier of this stored payment method.
+ type: string
+ issuerName:
+ x-addedInVersion: '68'
+ description: The name of the issuer of token or card.
+ type: string
+ lastFour:
+ description: The last four digits of the PAN.
+ type: string
+ name:
+ description: The display name of the stored payment method.
+ type: string
+ networkTxReference:
+ description: 'Returned in the response if you are not tokenizing with Adyen
+ and are using the Merchant-initiated transactions (MIT) framework from
+ Mastercard or Visa.
+
+
+ This contains either the Mastercard Trace ID or the Visa Transaction ID.'
+ type: string
+ ownerName:
+ x-addedInVersion: '67'
+ description: The name of the bank account holder.
+ type: string
+ shopperEmail:
+ description: "The shopper\u2019s email address."
+ type: string
+ shopperReference:
+ description: 'Your reference to uniquely identify this shopper, for example
+ user ID or account ID. Minimum length: 3 characters.
+
+ > Your reference must not include personally identifiable information
+ (PII), for example name or email address.'
+ maxLength: 256
+ minLength: 3
+ type: string
+ supportedRecurringProcessingModels:
+ x-addedInVersion: '70'
+ description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\
+ \ \u2013 A transaction for a fixed or variable amount, which follows a\
+ \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\
+ \ card details are stored to enable one-click or omnichannel journeys,\
+ \ or simply to streamline the checkout process. Any subscription not following\
+ \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\
+ \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\
+ \ that occurs on a non-fixed schedule and/or have variable amounts. For\
+ \ example, automatic top-ups when a cardholder's balance drops below a\
+ \ certain amount."
+ items:
+ type: string
+ type: array
+ type:
+ description: The type of payment method.
+ type: string
+ type: object
+ SubInputDetail:
+ properties:
+ configuration:
+ additionalProperties:
+ type: string
+ description: Configuration parameters for the required input.
+ type: object
+ items:
+ description: In case of a select, the items to choose from.
+ items:
+ $ref: '#/components/schemas/Item'
+ type: array
+ key:
+ description: The value to provide in the result.
+ type: string
+ optional:
+ description: True if this input is optional to provide.
+ type: boolean
+ type:
+ description: The type of the required input.
+ type: string
+ value:
+ description: The value can be pre-filled, if available.
+ type: string
+ type: object
+ SubMerchant:
+ properties:
+ city:
+ description: 'The city of the sub-merchant''s address.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 13 characters'
+ type: string
+ country:
+ description: "The three-letter country code of the sub-merchant's address.\
+ \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\
+ * Fixed length: 3 characters"
+ type: string
+ mcc:
+ description: "The sub-merchant's 4-digit Merchant Category Code (MCC). \n\
+ * Format: Numeric\n* Fixed length: 4 digits"
+ type: string
+ name:
+ description: 'The name of the sub-merchant. Based on scheme specifications,
+ this value will overwrite the shopper statement that will appear in the
+ card statement.
+
+ * Format: Alphanumeric
+
+ * Maximum length: 22 characters'
+ type: string
+ taxId:
+ description: 'The tax ID of the sub-merchant.
+
+ * Format: Numeric
+
+ * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
+ type: string
+ type: object
+ SubMerchantInfo:
+ properties:
+ address:
+ $ref: '#/components/schemas/BillingAddress'
+ id:
+ type: string
+ mcc:
+ type: string
+ name:
+ type: string
+ taxId:
+ type: string
+ type: object
+ ThreeDS2RequestData:
+ properties:
+ acctInfo:
+ x-addedInVersion: '68'
+ description: "Additional information about the Cardholder\u2019s account\
+ \ provided by the 3DS Requestor."
+ $ref: '#/components/schemas/AcctInfo'
+ acctType:
+ x-addedInVersion: '68'
+ description: "Indicates the type of account. For example, for a multi-account\
+ \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\
+ \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ maxLength: 2
+ minLength: 2
+ type: string
+ acquirerBIN:
+ x-addedInVersion: '49'
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The acquiring BIN enrolled for 3D Secure 2. This string should match the
+ value that you will use in the authorisation. Use 123456 on the Test platform.
+ type: string
+ acquirerMerchantID:
+ x-addedInVersion: '49'
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer.
+ This string should match the value that you will use in the authorisation.
+ Use 123456 on the Test platform.
+ type: string
+ addrMatch:
+ x-addedInVersion: '68'
+ description: "Indicates whether the Cardholder Shipping Address and Cardholder\
+ \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\
+ \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\
+ \ not match Billing Address."
+ enum:
+ - Y
+ - N
+ maxLength: 1
+ minLength: 1
+ type: string
+ authenticationOnly:
+ deprecated: true
+ x-deprecatedInVersion: '50'
+ x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ challengeIndicator:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
+ description: 'Possibility to specify a preference for receiving a challenge
+ from the issuer.
+
+ Allowed values:
+
+ * `noPreference`
+
+ * `requestNoChallenge`
+
+ * `requestChallenge`
+
+ * `requestChallengeAsMandate`
+
+ '
+ enum:
+ - noPreference
+ - requestNoChallenge
+ - requestChallenge
+ - requestChallengeAsMandate
+ type: string
+ deviceChannel:
+ description: 'The environment of the shopper.
+
+ Allowed values:
+
+ * `app`
+
+ * `browser`'
+ type: string
+ deviceRenderOptions:
+ description: 'Display options for the 3D Secure 2 SDK.
+
+ Optional and only for `deviceChannel` **app**.'
+ $ref: '#/components/schemas/DeviceRenderOptions'
+ homePhone:
+ x-addedInVersion: '68'
+ description: The home phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ mcc:
+ x-addedInVersion: '49'
+ description: Required for merchants that have been enrolled for 3D Secure
+ 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The `mcc` is a four-digit code with which the previously given `acquirerMerchantID`
+ is registered at the scheme.
+ type: string
+ merchantName:
+ x-addedInVersion: '49'
+ description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The merchant name that the issuer presents to the shopper if they get
+ a challenge. We recommend to use the same value that you will use in the
+ authorization. Maximum length is 40 characters.
+
+ > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration).
+ Use this field if you are enrolled for 3D Secure 2 with us and want to
+ override the merchant name already configured on your account.'
+ type: string
+ messageVersion:
+ description: The `messageVersion` value indicating the 3D Secure 2 protocol
+ version.
+ type: string
+ mobilePhone:
+ x-addedInVersion: '68'
+ description: The mobile phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ notificationURL:
+ description: URL to where the issuer should send the `CRes`. Required if
+ you are not using components for `channel` **Web** or if you are using
+ classic integration `deviceChannel` **browser**.
+ type: string
+ payTokenInd:
+ x-addedInVersion: '68'
+ description: Value **true** indicates that the transaction was de-tokenised
+ prior to being received by the ACS.
+ type: boolean
+ paymentAuthenticationUseCase:
+ x-addedInVersion: '68'
+ description: Indicates the type of payment for which an authentication is
+ requested (message extension)
+ type: string
+ platform:
+ description: 'The platform of the shopper.
+
+ Allowed values:
+
+ * `iOS`
+
+ * `android`
+
+ * `browser`'
+ enum:
+ - iOS
+ - android
+ - browser
+ type: string
+ purchaseInstalData:
+ x-addedInVersion: '68'
+ description: "Indicates the maximum number of authorisations permitted for\
+ \ instalment payments. Length: 1\u20133 characters."
+ maxLength: 3
+ minLength: 1
+ type: string
+ recurringExpiry:
+ x-addedInVersion: '68'
+ description: 'Date after which no further authorisations shall be performed.
+ Format: YYYYMMDD'
+ type: string
+ recurringFrequency:
+ x-addedInVersion: '68'
+ description: 'Indicates the minimum number of days between authorisations.
+ Maximum length: 4 characters.'
+ maxLength: 4
+ type: string
+ sdkAppID:
+ description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK.
+
+ Required for `deviceChannel` set to **app**.'
+ type: string
+ sdkEncData:
+ description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK.
+
+ Required for `deviceChannel` set to **app**.'
+ type: string
+ sdkEphemPubKey:
+ description: 'The `sdkEphemPubKey` value as received from the 3D Secure
+ 2 SDK.
+
+ Required for `deviceChannel` set to **app**.'
+ $ref: '#/components/schemas/SDKEphemPubKey'
+ sdkMaxTimeout:
+ default: 60
+ description: 'The maximum amount of time in minutes for the 3D Secure 2
+ authentication process.
+
+ Optional and only for `deviceChannel` set to **app**. Defaults to **60**
+ minutes.'
+ format: int32
+ type: integer
+ sdkReferenceNumber:
+ description: 'The `sdkReferenceNumber` value as received from the 3D Secure
+ 2 SDK.
+
+ Only for `deviceChannel` set to **app**.'
+ type: string
+ sdkTransID:
+ description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK.
+
+ Only for `deviceChannel` set to **app**.'
+ type: string
+ sdkVersion:
+ x-addedInVersion: '40'
+ description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\
+ \ set to **app**."
+ type: string
+ threeDSCompInd:
+ description: Completion indicator for the device fingerprinting.
+ type: string
+ threeDSRequestorAuthenticationInd:
+ x-addedInVersion: '68'
+ description: Indicates the type of Authentication request.
+ type: string
+ threeDSRequestorAuthenticationInfo:
+ x-addedInVersion: '68'
+ description: Information about how the 3DS Requestor authenticated the cardholder
+ before or during the transaction
+ $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
+ threeDSRequestorChallengeInd:
+ x-addedInVersion: '68'
+ description: "Indicates whether a challenge is requested for this transaction.\
+ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
+ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
+ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
+ \ \u2014 No challenge (transactional risk analysis is already performed)\n\
+ * **06** \u2014 Data Only"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ type: string
+ threeDSRequestorID:
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
+ for Visa. Unique 3D Secure requestor identifier assigned by the Directory
+ Server when you enrol for 3D Secure 2.
+ type: string
+ threeDSRequestorName:
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
+ for Visa. Unique 3D Secure requestor name assigned by the Directory Server
+ when you enrol for 3D Secure 2.
+ type: string
+ threeDSRequestorPriorAuthenticationInfo:
+ x-addedInVersion: '68'
+ description: Information about how the 3DS Requestor authenticated the cardholder
+ as part of a previous 3DS transaction.
+ $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
+ threeDSRequestorURL:
+ description: URL of the (customer service) website that will be shown to
+ the shopper in case of technical errors during the 3D Secure 2 process.
+ type: string
+ transType:
+ x-addedInVersion: '68'
+ description: "Identifies the type of transaction being authenticated. Length:\
+ \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\
+ * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\
+ \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\
+ \ Load"
+ enum:
+ - '01'
+ - '03'
+ - '10'
+ - '11'
+ - '28'
+ maxLength: 2
+ minLength: 2
+ type: string
+ transactionType:
+ x-addedInVersion: '50'
+ description: Identify the type of the transaction being authenticated.
+ enum:
+ - goodsOrServicePurchase
+ - checkAcceptance
+ - accountFunding
+ - quasiCashTransaction
+ - prepaidActivationAndLoad
+ type: string
+ whiteListStatus:
+ x-addedInVersion: '49'
+ description: The `whiteListStatus` value returned from a previous 3D Secure
+ 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
+ type: string
+ workPhone:
+ x-addedInVersion: '68'
+ description: The work phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ required:
+ - deviceChannel
+ type: object
+ ThreeDS2RequestFields:
+ properties:
+ acctInfo:
+ x-addedInVersion: '68'
+ description: "Additional information about the Cardholder\u2019s account\
+ \ provided by the 3DS Requestor."
+ $ref: '#/components/schemas/AcctInfo'
+ acctType:
+ x-addedInVersion: '68'
+ description: "Indicates the type of account. For example, for a multi-account\
+ \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\
+ \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ maxLength: 2
+ minLength: 2
+ type: string
+ acquirerBIN:
+ x-addedInVersion: '49'
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The acquiring BIN enrolled for 3D Secure 2. This string should match the
+ value that you will use in the authorisation. Use 123456 on the Test platform.
+ type: string
+ acquirerMerchantID:
+ x-addedInVersion: '49'
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer.
+ This string should match the value that you will use in the authorisation.
+ Use 123456 on the Test platform.
+ type: string
+ addrMatch:
+ x-addedInVersion: '68'
+ description: "Indicates whether the Cardholder Shipping Address and Cardholder\
+ \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\
+ \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\
+ \ not match Billing Address."
+ enum:
+ - Y
+ - N
+ maxLength: 1
+ minLength: 1
+ type: string
+ authenticationOnly:
+ deprecated: true
+ x-deprecatedInVersion: '50'
+ x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
+ default: false
+ description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only),
+ and not the payment authorisation.
+ type: boolean
+ challengeIndicator:
+ deprecated: true
+ x-deprecatedInVersion: '68'
+ x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
+ description: 'Possibility to specify a preference for receiving a challenge
+ from the issuer.
+
+ Allowed values:
+
+ * `noPreference`
+
+ * `requestNoChallenge`
+
+ * `requestChallenge`
+
+ * `requestChallengeAsMandate`
+
+ '
+ enum:
+ - noPreference
+ - requestNoChallenge
+ - requestChallenge
+ - requestChallengeAsMandate
+ type: string
+ deviceRenderOptions:
+ description: 'Display options for the 3D Secure 2 SDK.
+
+ Optional and only for `deviceChannel` **app**.'
+ $ref: '#/components/schemas/DeviceRenderOptions'
+ homePhone:
+ x-addedInVersion: '68'
+ description: The home phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ mcc:
+ x-addedInVersion: '49'
+ description: Required for merchants that have been enrolled for 3D Secure
+ 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The `mcc` is a four-digit code with which the previously given `acquirerMerchantID`
+ is registered at the scheme.
+ type: string
+ merchantName:
+ x-addedInVersion: '49'
+ description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).
+ The merchant name that the issuer presents to the shopper if they get
+ a challenge. We recommend to use the same value that you will use in the
+ authorization. Maximum length is 40 characters.
+
+ > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration).
+ Use this field if you are enrolled for 3D Secure 2 with us and want to
+ override the merchant name already configured on your account.'
+ type: string
+ messageVersion:
+ description: The `messageVersion` value indicating the 3D Secure 2 protocol
+ version.
+ type: string
+ mobilePhone:
+ x-addedInVersion: '68'
+ description: The mobile phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ notificationURL:
+ description: URL to where the issuer should send the `CRes`. Required if
+ you are not using components for `channel` **Web** or if you are using
+ classic integration `deviceChannel` **browser**.
+ type: string
+ payTokenInd:
+ x-addedInVersion: '68'
+ description: Value **true** indicates that the transaction was de-tokenised
+ prior to being received by the ACS.
+ type: boolean
+ paymentAuthenticationUseCase:
+ x-addedInVersion: '68'
+ description: Indicates the type of payment for which an authentication is
+ requested (message extension)
+ type: string
+ platform:
+ description: 'The platform of the shopper.
+
+ Allowed values:
+
+ * `iOS`
+
+ * `android`
+
+ * `browser`'
+ enum:
+ - iOS
+ - android
+ - browser
+ type: string
+ purchaseInstalData:
+ x-addedInVersion: '68'
+ description: "Indicates the maximum number of authorisations permitted for\
+ \ instalment payments. Length: 1\u20133 characters."
+ maxLength: 3
+ minLength: 1
+ type: string
+ recurringExpiry:
+ x-addedInVersion: '68'
+ description: 'Date after which no further authorisations shall be performed.
+ Format: YYYYMMDD'
+ type: string
+ recurringFrequency:
+ x-addedInVersion: '68'
+ description: 'Indicates the minimum number of days between authorisations.
+ Maximum length: 4 characters.'
+ maxLength: 4
+ type: string
+ sdkAppID:
+ description: The `sdkAppID` value as received from the 3D Secure 2 SDK.
+ type: string
+ sdkEphemPubKey:
+ description: The `sdkEphemPubKey` value as received from the 3D Secure 2
+ SDK.
+ $ref: '#/components/schemas/SDKEphemPubKey'
+ sdkMaxTimeout:
+ default: 60
+ description: 'The maximum amount of time in minutes for the 3D Secure 2
+ authentication process.
+
+ Optional and only for `deviceChannel` set to **app**. Defaults to **60**
+ minutes.'
+ format: int32
+ type: integer
+ sdkReferenceNumber:
+ description: The `sdkReferenceNumber` value as received from the 3D Secure
+ 2 SDK.
+ type: string
+ sdkTransID:
+ description: The `sdkTransID` value as received from the 3D Secure 2 SDK.
+ type: string
+ threeDSCompInd:
+ description: Completion indicator for the device fingerprinting.
+ type: string
+ threeDSRequestorAuthenticationInd:
+ x-addedInVersion: '68'
+ description: Indicates the type of Authentication request.
+ type: string
+ threeDSRequestorAuthenticationInfo:
+ x-addedInVersion: '68'
+ description: Information about how the 3DS Requestor authenticated the cardholder
+ before or during the transaction
+ $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
+ threeDSRequestorChallengeInd:
+ x-addedInVersion: '68'
+ description: "Indicates whether a challenge is requested for this transaction.\
+ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
+ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
+ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
+ \ \u2014 No challenge (transactional risk analysis is already performed)\n\
+ * **06** \u2014 Data Only"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ type: string
+ threeDSRequestorID:
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
+ for Visa. Unique 3D Secure requestor identifier assigned by the Directory
+ Server when you enrol for 3D Secure 2.
+ type: string
+ threeDSRequestorName:
+ description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only)
+ for Visa. Unique 3D Secure requestor name assigned by the Directory Server
+ when you enrol for 3D Secure 2.
+ type: string
+ threeDSRequestorPriorAuthenticationInfo:
+ x-addedInVersion: '68'
+ description: Information about how the 3DS Requestor authenticated the cardholder
+ as part of a previous 3DS transaction.
+ $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
+ threeDSRequestorURL:
+ description: URL of the (customer service) website that will be shown to
+ the shopper in case of technical errors during the 3D Secure 2 process.
+ type: string
+ transType:
+ x-addedInVersion: '68'
+ description: "Identifies the type of transaction being authenticated. Length:\
+ \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\
+ * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\
+ \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\
+ \ Load"
+ enum:
+ - '01'
+ - '03'
+ - '10'
+ - '11'
+ - '28'
+ maxLength: 2
+ minLength: 2
+ type: string
+ transactionType:
+ x-addedInVersion: '50'
+ description: Identify the type of the transaction being authenticated.
+ enum:
+ - goodsOrServicePurchase
+ - checkAcceptance
+ - accountFunding
+ - quasiCashTransaction
+ - prepaidActivationAndLoad
+ type: string
+ whiteListStatus:
+ x-addedInVersion: '49'
+ description: The `whiteListStatus` value returned from a previous 3D Secure
+ 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
+ type: string
+ workPhone:
+ x-addedInVersion: '68'
+ description: The work phone number provided by the Cardholder.
+ $ref: '#/components/schemas/Phone'
+ type: object
+ ThreeDS2ResponseData:
+ properties:
+ acsChallengeMandated:
+ type: string
+ acsOperatorID:
+ type: string
+ acsReferenceNumber:
+ type: string
+ acsSignedContent:
+ type: string
+ acsTransID:
+ type: string
+ acsURL:
+ type: string
+ authenticationType:
+ type: string
+ cardHolderInfo:
+ type: string
+ cavvAlgorithm:
+ type: string
+ challengeIndicator:
+ type: string
+ dsReferenceNumber:
+ type: string
+ dsTransID:
+ type: string
+ exemptionIndicator:
+ type: string
+ messageVersion:
+ type: string
+ riskScore:
+ type: string
+ sdkEphemPubKey:
+ type: string
+ threeDSServerTransID:
+ type: string
+ transStatus:
+ type: string
+ transStatusReason:
+ type: string
+ type: object
+ ThreeDS2Result:
+ properties:
+ authenticationValue:
+ description: The `authenticationValue` value as defined in the 3D Secure
+ 2 specification.
+ type: string
+ cavvAlgorithm:
+ x-addedInVersion: '50'
+ description: The algorithm used by the ACS to calculate the authentication
+ value, only for Cartes Bancaires integrations.
+ type: string
+ challengeCancel:
+ x-addedInVersion: '67'
+ description: Indicator informing the Access Control Server (ACS) and the
+ Directory Server (DS) that the authentication has been cancelled. For
+ possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ - '07'
+ type: string
+ dsTransID:
+ description: The `dsTransID` value as defined in the 3D Secure 2 specification.
+ type: string
+ eci:
+ description: The `eci` value as defined in the 3D Secure 2 specification.
+ type: string
+ exemptionIndicator:
+ x-addedInVersion: '67'
+ description: 'Indicates the exemption type that was applied by the issuer
+ to the authentication, if exemption applied.
+
+ Allowed values:
+
+ * `lowValue`
+
+ * `secureCorporate`
+
+ * `trustedBeneficiary`
+
+ * `transactionRiskAnalysis`
+
+ '
+ enum:
+ - lowValue
+ - secureCorporate
+ - trustedBeneficiary
+ - transactionRiskAnalysis
+ type: string
+ messageVersion:
+ x-addedInVersion: '49'
+ description: The `messageVersion` value as defined in the 3D Secure 2 specification.
+ type: string
+ riskScore:
+ x-addedInVersion: '67'
+ description: Risk score calculated by Cartes Bancaires Directory Server
+ (DS).
+ type: string
+ threeDSRequestorChallengeInd:
+ x-addedInVersion: '68'
+ description: "Indicates whether a challenge is requested for this transaction.\
+ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\
+ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\
+ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\
+ \ \u2014 No challenge (transactional risk analysis is already performed)\n\
+ * **06** \u2014 Data Only"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ type: string
+ threeDSServerTransID:
+ description: The `threeDSServerTransID` value as defined in the 3D Secure
+ 2 specification.
+ type: string
+ timestamp:
+ description: The `timestamp` value of the 3D Secure 2 authentication.
+ type: string
+ transStatus:
+ description: The `transStatus` value as defined in the 3D Secure 2 specification.
+ type: string
+ transStatusReason:
+ description: Provides information on why the `transStatus` field has the
+ specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
+ type: string
+ whiteListStatus:
+ x-addedInVersion: '49'
+ description: The `whiteListStatus` value as defined in the 3D Secure 2 specification.
+ type: string
+ type: object
+ ThreeDSRequestData:
+ properties:
+ challengeWindowSize:
+ x-addedInVersion: '69'
+ description: "Dimensions of the 3DS2 challenge window to be displayed to\
+ \ the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n\
+ * **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size\
+ \ of 600x400\n* **05** - Fullscreen"
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ type: string
+ dataOnly:
+ x-addedInVersion: '69'
+ description: Flag for data only flow.
+ enum:
+ - 'false'
+ - 'true'
+ type: string
+ nativeThreeDS:
+ x-addedInVersion: '69'
+ description: 'Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)
+ should be used when available.
+
+
+ Possible values:
+
+ * **preferred**: Use native 3D Secure authentication when available.'
+ enum:
+ - preferred
+ type: string
+ threeDSVersion:
+ x-addedInVersion: '69'
+ description: 'The version of 3D Secure to use.
+
+
+ Possible values:
+
+
+ * **2.1.0**
+
+ * **2.2.0**'
+ enum:
+ - 2.1.0
+ - 2.2.0
+ type: string
+ type: object
+ ThreeDSRequestorAuthenticationInfo:
+ properties:
+ threeDSReqAuthData:
+ description: 'Data that documents and supports a specific authentication
+ process. Maximum length: 2048 bytes.'
+ type: string
+ threeDSReqAuthMethod:
+ description: "Mechanism used by the Cardholder to authenticate to the 3DS\
+ \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\
+ \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\
+ * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\
+ \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\
+ \ the cardholder account at the 3DS Requestor system using federated ID.\n\
+ * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\
+ \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\
+ \ at the 3DS Requestor system using third-party authentication.\n* **06**\
+ \ \u2014 Login to the cardholder account at the 3DS Requestor system using\
+ \ FIDO Authenticator."
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ maxLength: 2
+ minLength: 2
+ type: string
+ threeDSReqAuthTimestamp:
+ description: 'Date and time in UTC of the cardholder authentication. Format:
+ YYYYMMDDHHMM'
+ maxLength: 12
+ minLength: 12
+ type: string
+ type: object
+ ThreeDSRequestorPriorAuthenticationInfo:
+ properties:
+ threeDSReqPriorAuthData:
+ description: 'Data that documents and supports a specific authentication
+ process. Maximum length: 2048 bytes.'
+ type: string
+ threeDSReqPriorAuthMethod:
+ description: "Mechanism used by the Cardholder to previously authenticate\
+ \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\
+ \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\
+ \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\
+ \ issuer methods."
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ maxLength: 2
+ minLength: 2
+ type: string
+ threeDSReqPriorAuthTimestamp:
+ description: 'Date and time in UTC of the prior cardholder authentication.
+ Format: YYYYMMDDHHMM'
+ maxLength: 12
+ minLength: 12
+ type: string
+ threeDSReqPriorRef:
+ description: 'This data element provides additional information to the ACS
+ to determine the best approach for handing a request. This data element
+ contains an ACS Transaction ID for a prior authenticated transaction.
+ For example, the first recurring transaction that was authenticated with
+ the cardholder. Length: 30 characters.'
+ maxLength: 36
+ minLength: 36
+ type: string
+ type: object
+ ThreeDSecureData:
+ properties:
+ authenticationResponse:
+ description: 'In 3D Secure 1, the authentication response if the shopper
+ was redirected.
+
+
+ In 3D Secure 2, this is the `transStatus` from the challenge result. If
+ the transaction was frictionless, omit this parameter.'
+ enum:
+ - Y
+ - N
+ - U
+ - A
+ type: string
+ cavv:
+ description: The cardholder authentication value (base64 encoded, 20 bytes
+ in a decoded form).
+ format: byte
+ type: string
+ cavvAlgorithm:
+ description: The CAVV algorithm used. Include this only for 3D Secure 1.
+ type: string
+ challengeCancel:
+ x-addedInVersion: '67'
+ description: Indicator informing the Access Control Server (ACS) and the
+ Directory Server (DS) that the authentication has been cancelled. For
+ possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
+ enum:
+ - '01'
+ - '02'
+ - '03'
+ - '04'
+ - '05'
+ - '06'
+ - '07'
+ type: string
+ directoryResponse:
+ description: 'In 3D Secure 1, this is the enrollment response from the 3D
+ directory server.
+
+
+ In 3D Secure 2, this is the `transStatus` from the `ARes`.'
+ enum:
+ - A
+ - C
+ - D
+ - I
+ - N
+ - R
+ - U
+ - Y
+ type: string
+ dsTransID:
+ x-addedInVersion: '40'
+ description: Supported for 3D Secure 2. The unique transaction identifier
+ assigned by the Directory Server (DS) to identify a single transaction.
+ type: string
+ eci:
+ description: The electronic commerce indicator.
+ type: string
+ riskScore:
+ x-addedInVersion: '67'
+ description: Risk score calculated by Directory Server (DS). Required for
+ Cartes Bancaires integrations.
+ type: string
+ threeDSVersion:
+ x-addedInVersion: '40'
+ description: The version of the 3D Secure protocol.
+ type: string
+ tokenAuthenticationVerificationValue:
+ x-addedInVersion: '68'
+ description: Network token authentication verification value (TAVV). The
+ network token cryptogram.
+ format: byte
+ type: string
+ transStatusReason:
+ x-addedInVersion: '67'
+ description: Provides information on why the `transStatus` field has the
+ specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
+ type: string
+ xid:
+ description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded,
+ 20 bytes in a decoded form).
+ format: byte
+ type: string
+ type: object
+ UpdatePaymentLinkRequest:
+ properties:
+ status:
+ description: 'Status of the payment link. Possible values:
+
+ * **expired**'
+ enum:
+ - expired
+ type: string
+ required:
+ - status
+ type: object
+ UpiCollectDetails:
+ additionalProperties: false
+ properties:
+ billingSequenceNumber:
+ description: The sequence number for the debit. For example, send **2**
+ if this is the second debit for the subscription. The sequence number
+ is included in the notification sent to the shopper.
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ shopperNotificationReference:
+ description: The `shopperNotificationReference` returned in the response
+ when you requested to notify the shopper. Used for recurring payment only.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: upi_collect
+ description: '**upi_collect**'
+ enum:
+ - upi_collect
+ type: string
+ virtualPaymentAddress:
+ description: The virtual payment address for UPI.
+ type: string
+ required:
+ - type
+ - billingSequenceNumber
+ title: UPI Collect
+ type: object
+ UpiIntentDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ shopperNotificationReference:
+ description: The `shopperNotificationReference` returned in the response
+ when you requested to notify the shopper. Used for recurring payment only.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: upi_intent
+ description: '**upi_intent**'
+ enum:
+ - upi_intent
+ type: string
+ required:
+ - type
+ title: UPI Intent
+ type: object
+ UtilityRequest:
+ properties:
+ originDomains:
+ description: The list of origin domains, for which origin keys are requested.
+ items:
+ type: string
+ type: array
+ required:
+ - originDomains
+ type: object
+ UtilityResponse:
+ properties:
+ originKeys:
+ x-addedInVersion: '1'
+ additionalProperties:
+ type: string
+ description: The list of origin keys for all requested domains. For each
+ list item, the key is the domain and the value is the origin key.
+ type: object
+ type: object
+ VippsDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ telephoneNumber:
+ description: ''
+ type: string
+ type:
+ default: vipps
+ description: '**vipps**'
+ enum:
+ - vipps
+ type: string
+ required:
+ - telephoneNumber
+ title: Vipps
+ type: object
+ VisaCheckoutDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ fundingSource:
+ description: The funding source that should be used when multiple sources
+ are available. For Brazilian combo cards, by default the funding source
+ is credit. To use debit, set this value to **debit**.
+ enum:
+ - credit
+ - debit
+ type: string
+ type:
+ default: visacheckout
+ description: '**visacheckout**'
+ enum:
+ - visacheckout
+ type: string
+ visaCheckoutCallId:
+ description: The Visa Click to Pay Call ID value. When your shopper selects
+ a payment and/or a shipping address from Visa Click to Pay, you will receive
+ a Visa Click to Pay Call ID.
+ type: string
+ required:
+ - visaCheckoutCallId
+ title: Visa Checkout
+ type: object
+ WeChatPayDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ type:
+ default: wechatpay
+ description: '**wechatpay**'
+ enum:
+ - wechatpay
+ - wechatpay_pos
+ type: string
+ title: WeChat Pay
+ type: object
+ WeChatPayMiniProgramDetails:
+ additionalProperties: false
+ properties:
+ appId:
+ type: string
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ openid:
+ type: string
+ type:
+ default: wechatpayMiniProgram
+ description: '**wechatpayMiniProgram**'
+ enum:
+ - wechatpayMiniProgram
+ type: string
+ title: WeChat Pay - Mini Program
+ type: object
+ ZipDetails:
+ additionalProperties: false
+ properties:
+ checkoutAttemptId:
+ x-addedInVersion: '68'
+ description: The checkout attempt identifier.
+ type: string
+ clickAndCollect:
+ description: Set this to **true** if the shopper would like to pick up and
+ collect their order, instead of having the goods delivered to them.
+ type: string
+ recurringDetailReference:
+ deprecated: true
+ x-deprecatedInVersion: '49'
+ x-deprecatedMessage: Use `storedPaymentMethodId` instead.
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ type: string
+ storedPaymentMethodId:
+ x-addedInVersion: '49'
+ description: This is the `recurringDetailReference` returned in the response
+ when you created the token.
+ maxLength: 64
+ type: string
+ type:
+ default: zip
+ description: '**zip**'
+ enum:
+ - zip
+ - zip_pos
+ type: string
+ title: Zip
+ type: object
+ securitySchemes:
+ ApiKeyAuth:
+ in: header
+ name: X-API-Key
+ type: apiKey
+ BasicAuth:
+ scheme: basic
+ type: http
+ headers:
+ Idempotency-Key:
+ description: The idempotency key used for processing the request. Present if
+ the key was provided in the request.
+ schema:
+ type: string
+ parameters:
+ Idempotency-Key:
+ description: A unique identifier for the message with a maximum of 64 characters
+ (we recommend a UUID).
+ example: 37ca9c97-d1d1-4c62-89e8-706891a563ed
+ name: Idempotency-Key
+ in: header
+ schema:
+ type: string
+ examples:
+ generic-400:
+ summary: Response code 400. Bad request.
+ value:
+ status: 400
+ errorCode: '702'
+ message: 'Unexpected input: ", expected: }'
+ errorType: validation
+ generic-401:
+ summary: Response code 401. Unauthorized.
+ value:
+ status: 401
+ errorCode: '000'
+ message: HTTP Status Response - Unauthorized
+ errorType: security
+ generic-403:
+ summary: Response code 403. Forbidden.
+ value:
+ status: 403
+ errorCode: '901'
+ message: Invalid Merchant Account
+ errorType: security
+ pspReference: 881611827877203B
+ generic-422:
+ summary: Response code 422. Unprocessable entity.
+ value:
+ status: 422
+ errorCode: '14_030'
+ message: Return URL is missing.
+ errorType: validation
+ pspReference: '8816118280275544'
+ generic-500:
+ summary: Response code 500. Internal server error.
+ value:
+ status: 500
+ errorCode: '905'
+ message: Payment details are not supported
+ errorType: configuration
+ pspReference: '8516091485743033'
+ get-paymentLinks-linkId-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ amount:
+ currency: EUR
+ value: 8700
+ countryCode: NL
+ expiresAt: '2021-04-08T14:06:39Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: shopper-reference-ekvL83
+ shopperLocale: hu-HU
+ shopperReference: shopper-reference-LZfdWZ
+ status: active
+ url: https://test.adyen.link/PL61C53A8B97E6915A
+ id: PL61C53A8B97E6915A
+ get-sessions-sessionId-success-200:
+ summary: 'Response code: 200 - Success'
+ description: The status of the session with the specified ID.
+ value:
+ id: CS12345678
+ status: completed
+ get-storedPaymentMethods-success-200:
+ summary: List of stored payment methods for specified shopper
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ storedPaymentMethods:
+ - brand: visa
+ expiryMonth: '10'
+ expiryYear: '30'
+ holderName: John Smith
+ id: '7219687191761347'
+ issuerName: ISSUER_NAME
+ lastFour: '1111'
+ name: VISA
+ shopperEmail: john.smith@example.com
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ supportedRecurringProcessingModels:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: scheme
+ patch-paymentLinks-linkId-basic:
+ summary: Update the status of a payment link
+ value:
+ status: expired
+ patch-paymentLinks-linkId-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ amount:
+ currency: EUR
+ value: 8700
+ countryCode: NL
+ expiresAt: '2021-04-08T14:06:39Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: shopper-reference-ekvL83
+ shopperLocale: hu-HU
+ shopperReference: shopper-reference-LZfdWZ
+ status: expired
+ url: https://test.adyen.link/PL61C53A8B97E6915A
+ id: PL61C53A8B97E6915A
+ post-applePay-sessions-basic:
+ summary: Get payment session for Apple Pay
+ value:
+ displayName: YOUR_MERCHANT_NAME
+ domainName: YOUR_DOMAIN_NAME
+ merchantIdentifier: YOUR_MERCHANT_ID
+ post-applePay-sessions-basic-200:
+ summary: Payment session data for Apple Pay
+ value:
+ data: eyJ2Z...
+ post-cancels-cancel-with-own-reference:
+ summary: Cancel a payment using your own reference
+ description: Example cancel request with your own reference
+ value:
+ paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT
+ reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-cancels-cancel-with-own-reference-201:
+ summary: Payment cancellation requested
+ description: Example response when a payment cancellation was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT
+ reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION
+ pspReference: 993617894906488A
+ status: received
+ post-cardDetails-basic:
+ summary: Get a list of brands on a card
+ description: Example request for getting a list of brands on a card using the
+ first 6 digits of the card number.
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ cardNumber: '411111'
+ post-cardDetails-basic-200:
+ summary: List of brands on the card
+ description: Example response when the card is co-branded.
+ value:
+ brands:
+ - type: visa
+ supported: true
+ - type: cartebancaire
+ supported: true
+ post-cardDetails-supported-brands:
+ summary: Get a list of brands on a card specifying your supported card brands
+ description: Example request for getting a list of brands on a card using the
+ first 6 digits of the card number and including the card brands you support.
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ cardNumber: '411111'
+ supportedBrands:
+ - visa
+ - mc
+ - amex
+ post-cardDetails-supported-brands-200:
+ summary: List of brands on the card when you specify your supported card brands
+ description: Example response when the card is co-branded, and you only support
+ Visa.
+ value:
+ brands:
+ - type: visa
+ supported: true
+ - type: cartebancaire
+ supported: false
+ post-donations-donations:
+ summary: Start a donation transaction
+ value:
+ amount:
+ currency: EUR
+ value: 1000
+ reference: YOUR_DONATION_REFERENCE
+ paymentMethod:
+ type: scheme
+ donationToken: YOUR_DONATION_TOKEN
+ donationOriginalPspReference: 991559660454807J
+ donationAccount: CHARITY_ACCOUNT
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ shopperInteraction: ContAuth
+ post-donations-donations-200:
+ summary: Example response
+ value:
+ id: UNIQUE_RESOURCE_ID
+ status: completed
+ donationAccount: CHARITY_ACCOUNT
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ amount:
+ currency: EUR
+ value: 1000
+ reference: YOUR_DONATION_REFERENCE
+ payment:
+ pspReference: '8535762347980628'
+ resultCode: Authorised
+ amount:
+ currency: EUR
+ value: 1000
+ merchantReference: YOUR_DONATION_REFERENCE
+ post-donations-donations-with-token:
+ summary: Start a donation transaction with a token
+ value:
+ amount:
+ currency: EUR
+ value: 1000
+ reference: YOUR_DONATION_REFERENCE
+ paymentMethod:
+ type: scheme
+ recurringDetailReference: '7219687191761347'
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ donationAccount: CHARITY_ACCOUNT
+ shopperInteraction: ContAuth
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ recurringProcessingModel: CardOnFile
+ post-orders-basic:
+ summary: Create an order
+ value:
+ reference: YOUR_ORDER_REFERENCE
+ amount:
+ value: 2500
+ currency: EUR
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-orders-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ pspReference: '8616178914061985'
+ resultCode: Success
+ expiresAt: '2021-04-09T14:16:46Z'
+ orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==
+ reference: shopper-reference-ekvL83
+ remainingAmount:
+ currency: EUR
+ value: 2500
+ amount:
+ currency: EUR
+ value: 300
+ post-orders-cancel-basic:
+ summary: Cancel an order
+ value:
+ order:
+ pspReference: '8815517812932012'
+ orderData: 823fh892f8f18f4...148f13f9f3f
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-orders-cancel-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ pspReference: '8816178914079738'
+ resultCode: Received
+ post-originKeys-basic:
+ summary: Get origin keys
+ value:
+ originDomains:
+ - https://www.your-domain1.com
+ - https://www.your-domain2.com
+ - https://www.your-domain3.com
+ post-originKeys-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ originKeys:
+ https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw
+ https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc
+ https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg
+ post-paymentLinks-basic:
+ summary: Create a payment link
+ value:
+ reference: YOUR_ORDER_NUMBER
+ amount:
+ value: 1250
+ currency: BRL
+ countryCode: BR
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ shopperEmail: test@email.com
+ shopperLocale: pt-BR
+ billingAddress:
+ street: Roque Petroni Jr
+ postalCode: '59000060'
+ city: "S\xE3o Paulo"
+ houseNumberOrName: '999'
+ country: BR
+ stateOrProvince: SP
+ deliveryAddress:
+ street: Roque Petroni Jr
+ postalCode: '59000060'
+ city: "S\xE3o Paulo"
+ houseNumberOrName: '999'
+ country: BR
+ stateOrProvince: SP
+ post-paymentLinks-basic-201:
+ summary: Payment link created
+ value:
+ amount:
+ currency: BRL
+ value: 1250
+ billingAddress:
+ city: "S\xE3o Paulo"
+ country: BR
+ houseNumberOrName: '999'
+ postalCode: '59000060'
+ stateOrProvince: SP
+ street: Roque Petroni Jr
+ countryCode: BR
+ deliveryAddress:
+ city: "S\xE3o Paulo"
+ country: BR
+ houseNumberOrName: '999'
+ postalCode: '59000060'
+ stateOrProvince: SP
+ street: Roque Petroni Jr
+ expiresAt: '2022-10-28T09:16:22Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_ORDER_NUMBER
+ reusable: false
+ shopperEmail: test@email.com
+ shopperLocale: pt-BR
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ id: PLE83C39B0A0DE0C1E
+ status: active
+ url: https://test.adyen.link/PLE83C39B0A0DE0C1E
+ post-paymentMethods-balance-basic:
+ summary: Get gift card balance specifying amount of 10 EUR
+ value:
+ paymentMethod:
+ type: givex
+ number: '4126491073027401'
+ cvc: '737'
+ amount:
+ currency: EUR
+ value: 1000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentMethods-balance-basic-200:
+ summary: Gift card balance greater than amount specified in request
+ value:
+ pspReference: KHQC5N7G84BLNK43
+ resultCode: Success
+ balance:
+ currency: EUR
+ value: 5000
+ post-paymentMethods-balance-not-enough:
+ summary: Get gift card balance specifying amount of 100 EUR
+ value:
+ paymentMethod:
+ type: givex
+ number: '4126491073027401'
+ cvc: '737'
+ amount:
+ currency: EUR
+ value: 10000
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentMethods-balance-not-enough-200:
+ summary: Gift card balance lower than amount specified in request
+ value:
+ pspReference: FKSPNCQ8HXSKGK82
+ resultCode: NotEnoughBalance
+ balance:
+ currency: EUR
+ value: 5000
+ post-paymentMethods-basic:
+ summary: Get available payment methods
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentMethods-basic-200:
+ summary: Example response for request 'basic'
+ value:
+ paymentMethods:
+ - name: ACH Direct Debit
+ type: ach
+ - name: Adyen Voucher
+ type: adyen_test_voucher
+ - name: AfterPay Invoice
+ type: afterpay_default
+ - name: AfterPay DirectDebit
+ type: afterpay_directdebit
+ - name: Afterpay
+ type: afterpaytouch
+ - name: Cards
+ type: scheme
+ - name: AliPay
+ type: alipay
+ - name: AliPay HK
+ type: alipay_hk
+ - name: AliPay
+ type: alipay_wap
+ - name: Android Pay
+ type: androidpay
+ - name: Apple Pay
+ type: applepay
+ - name: Credit Card via AsiaPay
+ type: asiapay
+ - name: China UnionPay
+ type: asiapay_unionpay
+ - name: Baby Gift Card
+ type: babygiftcard
+ - name: Baloto
+ type: baloto
+ - name: BancNet
+ type: bancnet
+ - name: Bank Transfer (BG)
+ type: bankTransfer_BG
+ - name: Bank Transfer (CH)
+ type: bankTransfer_CH
+ - name: Bank Transfer (DE)
+ type: bankTransfer_DE
+ - name: Bank Transfer (FI)
+ type: bankTransfer_FI
+ - name: Bank Transfer (GB)
+ type: bankTransfer_GB
+ - name: Bank Transfer (HU)
+ type: bankTransfer_HU
+ - name: SEPA Bank Transfer
+ type: bankTransfer_IBAN
+ - name: Bank Transfer (IE)
+ type: bankTransfer_IE
+ - name: Electronic Bank Transfer (MX)
+ type: bankTransfer_MX_linked
+ - name: Bank Transfer (MX)
+ type: bankTransfer_MX_offline
+ - name: Bank Transfer (NL)
+ type: bankTransfer_NL
+ - name: Bank Transfer (PL)
+ type: bankTransfer_PL
+ - name: Bank Transfer (SE)
+ type: bankTransfer_SE
+ - name: Bank Transfer (US)
+ type: bankTransfer_US
+ - name: Payconiq by Bancontact
+ type: bcmc_mobile
+ - name: Bijenkorf Cadeaucard
+ type: bijcadeaucard
+ - name: 99Bill
+ type: bill99
+ - name: Online Banking India
+ type: billdesk_online
+ - name: UPI
+ type: billdesk_upi
+ - name: Wallets India
+ type: billdesk_wallet
+ - name: Blik
+ type: blik
+ - name: Bloemen Giftcard
+ type: bloemengiftcard
+ - name: Boekenbon Giftcard
+ type: boekenbon
+ - name: Boleto
+ type: boleto
+ - name: Boleto Bancario
+ type: boletobancario_santander
+ - name: Bradesco
+ type: bradesco
+ - name: Cash-Ticket
+ type: cashticket
+ - name: CashU
+ type: cashu
+ - name: CCAvenue
+ type: ccavenue
+ - name: Mula Checkout
+ type: cellulant
+ - name: Chasin Giftcard
+ type: chasingiftcard
+ - name: Clearpay
+ type: clearpay
+ - name: ClickandBuy
+ type: clickandbuy
+ - name: Paiement en 3 fois par Cartes Bancaires
+ type: cofinoga_3xcb
+ - name: Costes Giftcard
+ type: costesgiftcard
+ - name: custom_settlement
+ type: custom_settlement
+ - name: DANA
+ type: dana
+ - name: DineroMail
+ type: dineromail
+ - name: Online bank transfer.
+ type: directEbanking
+ - name: Direct Debit Brazil - Banco do Brazil
+ type: directdebit_BR_bancodobrasil
+ - name: Direct Debit Brazil - Bradesco
+ type: directdebit_BR_bradesco
+ - name: Direct Debit Brazil - Caixa Economica Federal
+ type: directdebit_BR_caixa
+ - name: Direct Debit Brazil - HSBC
+ type: directdebit_BR_hsbc
+ - name: Direct Debit Brazil - Itau
+ type: directdebit_BR_itau
+ - name: Direct Debit Brazil - Santander
+ type: directdebit_BR_santander
+ - name: BACS Direct Debit
+ type: directdebit_GB
+ - name: Alfamart
+ type: doku_alfamart
+ - name: BCA Bank Transfer
+ type: doku_bca_va
+ - name: BNI VA
+ type: doku_bni_va
+ - name: BRI VA
+ type: doku_bri_va
+ - name: CIMB VA
+ type: doku_cimb_va
+ - name: Danamon VA
+ type: doku_danamon_va
+ - name: Indomaret
+ type: doku_indomaret
+ - name: Mandiri VA
+ type: doku_mandiri_va
+ - name: OVO
+ type: doku_ovo
+ - name: Bank Transfer
+ type: doku_permata_lite_atm
+ - name: DOKU wallet
+ type: doku_wallet
+ - name: Local Polish Payment Methods
+ type: dotpay
+ - name: Dragonpay Prepaid Credits
+ type: dragonpay_credits
+ - name: Online Banking
+ type: dragonpay_ebanking
+ - name: GCash
+ type: dragonpay_gcash
+ - name: Over The Counter Banks
+ type: dragonpay_otc_banking
+ - name: OTC non-Bank via Dragonpay
+ type: dragonpay_otc_non_banking
+ - name: Convenience Stores
+ type: dragonpay_otc_philippines
+ - name: 7/11
+ type: dragonpay_seveneleven
+ - name: eagleeye_voucher
+ type: eagleeye_voucher
+ - name: Finnish E-Banking
+ type: ebanking_FI
+ - name: Pay-easy ATM
+ type: econtext_atm
+ - name: Online Banking
+ type: econtext_online
+ - name: 7-Eleven
+ type: econtext_seven_eleven
+ - name: Convenience Stores
+ type: econtext_stores
+ - name: eft_directdebit_CA
+ type: eft_directdebit_CA
+ - name: Lastschrift (ELV)
+ type: elv
+ - name: Bank Payment
+ type: entercash
+ - name: Nationale Entertainment Card
+ type: entertainmentcard
+ - name: EPS
+ type: eps
+ - name: Expert Cadeaukaart
+ type: expertgiftcard
+ - name: 3x Oney
+ type: facilypay_3x
+ - name: 4x Oney
+ type: facilypay_4x
+ - name: Fashioncheque
+ type: fashioncheque
+ - name: Fawry
+ type: fawry
+ - name: FijnCadeau
+ type: fijncadeau
+ - name: Fleurop Bloemenbon
+ type: fleuropbloemenbon
+ - name: Fonq Giftcard
+ type: fonqgiftcard
+ - name: Gall & Gall
+ type: gallgall
+ - name: GCash
+ type: gcash
+ - name: Generic GiftCard
+ type: genericgiftcard
+ - name: GiftFor2
+ type: giftfor2card
+ - name: Givex
+ type: givex
+ - name: Globe GCash
+ type: globegcash
+ - name: Goldsmiths Card
+ type: goldsmithscard
+ - name: GoPay Wallet
+ type: gopay_wallet
+ - name: OVO
+ type: grabpay_ID
+ - name: GrabPay
+ type: grabpay_PH
+ - name: GrabPay
+ type: grabpay_SG
+ - name: Hallmark Card
+ type: hallmarkcard
+ - name: HDFC
+ type: hdfc
+ - name: Hunkemoller Member Card
+ type: hmclub
+ - name: Hunkemoller Lingerie Card
+ type: hmlingerie
+ - name: iDEAL
+ type: ideal
+ - name: igive
+ type: igive
+ - name: Korean Account Transfer (IniPay)
+ type: inicisIniPay_accounttransfer
+ - name: Korean Credit Cards (IniPay)
+ type: inicisIniPay_creditcard
+ - name: Korean Mobile Phone (IniPay)
+ type: inicisIniPay_mobilephone
+ - name: Korean Virtual Account (IniPay)
+ type: inicisIniPay_virtualaccount
+ - name: Korean Account Transfer (Mobile)
+ type: inicisMobile_accounttransfer
+ - name: Korean Credit Cards (Mobile)
+ type: inicisMobile_creditcard
+ - name: Korean Mobile Phone (Mobile)
+ type: inicisMobile_mobilephone
+ - name: Korean Virtual Account (Mobile)
+ type: inicisMobile_virtualaccount
+ - name: Korean Credit Cards
+ type: inicis_creditcard
+ - name: "Interac\xAE Online"
+ type: interac
+ - name: Instant EFT
+ type: ipay
+ - name: iPay88
+ type: ipay88
+ - name: isracard
+ type: isracard
+ - name: Phone Payment
+ type: ivr
+ - name: Landline phone
+ type: ivrLandline
+ - name: Mobile phone
+ type: ivrMobile
+ - name: Kado Wereld
+ type: kadowereld
+ - name: KakaoPay
+ type: kakaopay
+ - name: Karen Millen Card
+ type: karenmillen
+ - name: Karen Millen GiftCard
+ type: karenmillengiftcard
+ - name: Bank Transfer
+ type: kcp_banktransfer
+ - name: "Korea\u2013issued cards"
+ type: kcp_creditcard
+ - name: PayCo
+ type: kcp_payco
+ - name: Naver Pay
+ type: kcp_naverpay
+ - name: Virtual Account via KCP
+ type: kcp_va
+ - name: Pay later with Klarna.
+ type: klarna
+ - name: Pay over time with Klarna.
+ type: klarna_account
+ - name: Buy Now, Pay Later with Billie
+ type: klarna_b2b
+ - name: Pay now with Klarna.
+ type: klarna_paynow
+ - name: Leisure Card
+ type: leisurecard
+ - name: China Credit Card
+ type: lianlianpay_creditcard
+ - name: China Debit Card
+ type: lianlianpay_debitcard
+ - name: China Online Banking - Credit Card
+ type: lianlianpay_ebanking_credit
+ - name: China Online Banking - Debit Card
+ type: lianlianpay_ebanking_debit
+ - name: China Online Banking - Enterprise
+ type: lianlianpay_ebanking_enterprise
+ - name: Loods5 Cadeaukaart
+ type: loods5giftcard
+ - name: Loods5 Tegoedbon
+ type: loods5prepaidcard
+ - name: Love2Shop GiftCard
+ type: love2shop
+ - name: mada
+ type: mada
+ - name: Mappin & Webb Card
+ type: mappinwebbcard
+ - name: MB WAY
+ type: mbway
+ - name: Amazon Pay
+ type: amazonpay
+ - name: Mercado Pago
+ type: mercadopago
+ - name: MobilePay
+ type: mobilepay
+ - name: AliPay via Razer Merchant Services
+ type: molpay_alipay
+ - name: 7-Eleven
+ type: molpay_cash
+ - name: CIMB Virtual Account
+ type: molpay_cimb_va
+ - name: Malaysia E-Banking via Razer Merchant Services
+ type: molpay_ebanking_MY
+ - name: Vietnam E-Banking
+ type: molpay_ebanking_VN
+ - name: Malaysia E-Banking
+ type: molpay_ebanking_fpx_MY
+ - name: eNETS Debit
+ type: molpay_enetsd
+ - name: epay
+ type: molpay_epay
+ - name: Esapay
+ type: molpay_esapay
+ - name: MyClear FPX
+ type: molpay_fpx
+ - name: Maybank2u
+ type: molpay_maybank2u
+ - name: Nganluong
+ type: molpay_nganluong
+ - name: Convenience Stores Thailand
+ type: molpay_paysbuy
+ - name: MOLPoints
+ type: molpay_points
+ - name: RHB Now
+ type: molpay_rhb
+ - name: SAM by SingPost
+ type: molpay_singpost
+ - name: MOLWallet
+ type: molpay_wallet
+ - name: MoMo ATM
+ type: momo_atm
+ - name: Momo Wallet
+ type: momo_wallet
+ - name: Moneybookers
+ type: moneybookers
+ - name: Multibanco
+ type: multibanco
+ - name: De Nationale Musicalcard
+ type: musicalcard
+ - name: Nationale Bioscoopbon
+ type: nationalebioscoopbon
+ - name: Nationale Tuinbon
+ type: nationaletuinbon
+ - name: Nationale Verwen Cadeaubon
+ type: nationaleverwencadeaubon
+ - name: BankAxess
+ type: netaxept_bankaxess
+ - name: NETELLER
+ type: neteller
+ - name: Onebip
+ type: onebip
+ - name: One Two Three
+ type: onetwothree
+ - name: Online Banking PL
+ type: onlineBanking_PL
+ - name: Online banking
+ type: openbanking_UK
+ - name: Oxxo
+ type: oxxo
+ - name: Pathe Giftcard
+ type: pathegiftcard
+ - name: PayBright
+ type: paybright
+ - name: Maya Wallet
+ type: paymaya_wallet
+ - name: PayPal
+ type: paypal
+ - name: Paysafecard
+ type: paysafecard
+ - name: Payshop
+ type: payshop
+ - name: PayD AMT via Paythru
+ type: paythru_amt
+ - name: EFT via Paythru
+ type: paythru_eft
+ - name: PayTM
+ type: paytm
+ - name: PayU UPI
+ type: payu_IN_upi
+ - name: EFT Pro via PayU
+ type: payu_ZA_eftpro
+ - name: Google Pay
+ type: paywithgoogle
+ - name: pix
+ type: pix
+ - name: Plastix
+ type: plastix
+ - name: Pluim
+ type: pluimgiftcard
+ - name: Podium Card
+ type: podiumcard
+ - name: POLi
+ type: poli
+ - name: PPS
+ type: pps
+ - name: Primera Cadeaukaart
+ type: primeracadeaucard
+ - name: Illicado Gift Card
+ type: prosodie_illicado
+ - name: PSE
+ type: pse
+ - name: Qiwi Wallet
+ type: qiwiwallet
+ - name: RatePay Invoice
+ type: ratepay
+ - name: RatePay Direct Debit
+ type: ratepay_directdebit
+ - name: Rituals Giftcard
+ type: rituals
+ - name: Rob Peetoom Giftcard
+ type: robpeetoomgiftcard
+ - name: SafetyPay
+ type: safetypay
+ - name: SafetyPay Cash
+ type: safetypay_cash
+ - name: Shoes&Accessories Cadeau
+ type: sagiftcard
+ - name: Score Giftcard
+ type: scoregiftcard
+ - name: SEB Direktbetalning
+ type: sebdirectpayment
+ - name: SEPA Direct Debit
+ type: sepadirectdebit
+ - name: 7-Eleven
+ type: seveneleven
+ - name: Premium SMS
+ type: sms
+ - name: SVS
+ type: svs
+ - name: Swish
+ type: swish
+ - name: TCS Test GiftCard
+ type: tcstestgiftcard
+ - name: TenPay
+ type: tenpay
+ - name: The Sting Giftcard
+ type: thestinggiftcard
+ - name: TrueMoney
+ type: truemoney
+ - name: Trustly
+ type: trustly
+ - name: Online Banking by Trustpay
+ type: trustpay
+ - name: TWINT
+ type: twint
+ - name: Ukash
+ type: ukash
+ - name: UnionPay
+ type: unionpay
+ - name: UPI Collect
+ type: upi_collect
+ - name: Valuelink
+ type: valuelink
+ - name: V&D Cadeaukaart
+ type: vdcadeaucard
+ - name: Vipps
+ type: vipps
+ - name: Visa Checkout
+ type: visacheckout
+ - name: VVV Cadeaubon
+ type: vvvcadeaubon
+ - name: VVV Giftcard
+ type: vvvgiftcard
+ - name: Webshop Giftcard
+ type: webshopgiftcard
+ - name: WeChat Pay
+ type: wechatpayMiniProgram
+ - name: WeChat Pay
+ type: wechatpayQR
+ - name: WeChat Pay
+ type: wechatpayWeb
+ - name: WE Fashion Giftcard
+ type: wefashiongiftcard
+ - name: Western Union
+ type: westernunion
+ - name: Winkel Cheque
+ type: winkelcheque
+ - name: WOS Card
+ type: woscard
+ - name: Alfa-Click
+ type: yandex_alfaclick
+ - name: Pay using bank card
+ type: yandex_bank_card
+ - name: Cash terminals
+ type: yandex_cash
+ - name: Pay using installments
+ type: yandex_installments
+ - name: YooMoney
+ type: yandex_money
+ - name: Promsvyazbank
+ type: yandex_promsvyazbank
+ - name: SberPay
+ type: yandex_sberbank
+ - name: WebMoney
+ type: yandex_webmoney
+ - name: Your Gift
+ type: yourgift
+ - name: Zip
+ type: zip
+ post-paymentMethods-filtered:
+ summary: Get payment methods based on the country and amount
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ countryCode: NL
+ shopperLocale: nl-NL
+ amount:
+ currency: EUR
+ value: 1000
+ post-paymentMethods-filtered-200:
+ summary: Example response for request 'filtered'
+ value:
+ paymentMethods:
+ - name: iDEAL
+ type: ideal
+ - name: "Hitelk\xE1rtya"
+ type: scheme
+ - name: PayPal
+ type: paypal
+ - name: AfterPay Invoice
+ type: afterpay_default
+ - name: Pay later with Klarna.
+ type: klarna
+ - name: SEPA Direct Debit
+ type: sepadirectdebit
+ - name: Paysafecard
+ type: paysafecard
+ - name: Bijenkorf Cadeaucard
+ type: bijcadeaucard
+ - name: Fonq Giftcard
+ type: fonqgiftcard
+ - name: Bank Transfer (NL)
+ type: bankTransfer_NL
+ - name: Pathe Giftcard
+ type: pathegiftcard
+ - name: VVV Giftcard
+ type: vvvgiftcard
+ - name: Podium Card
+ type: podiumcard
+ - name: RatePay Direct Debit
+ type: ratepay_directdebit
+ - name: Rituals Giftcard
+ type: rituals
+ - name: Hunkemoller Lingerie Card
+ type: hmlingerie
+ - name: Primera Cadeaukaart
+ type: primeracadeaucard
+ - name: Fashioncheque
+ type: fashioncheque
+ - name: NETELLER
+ type: neteller
+ - name: Adyen Voucher
+ type: adyen_test_voucher
+ - name: AfterPay B2B
+ type: afterpay_b2b
+ - name: AfterPay DirectDebit
+ type: afterpay_directdebit
+ - name: AliPay
+ type: alipay
+ - name: AliPay
+ type: alipay_wap
+ - name: Android Pay
+ type: androidpay
+ - name: Apple Pay
+ type: applepay
+ - name: Baby Gift Card
+ type: babygiftcard
+ - name: SEPA Bank Transfer
+ type: bankTransfer_IBAN
+ - name: Bloemen Giftcard
+ type: bloemengiftcard
+ - name: Boekenbon Giftcard
+ type: boekenbon
+ - name: Cash-Ticket
+ type: cashticket
+ - name: Chasin Giftcard
+ type: chasingiftcard
+ - name: ClickandBuy
+ type: clickandbuy
+ - name: Costes Giftcard
+ type: costesgiftcard
+ - name: custom_settlement
+ type: custom_settlement
+ - name: eft_directdebit_CA
+ type: eft_directdebit_CA
+ - name: Nationale Entertainment Card
+ type: entertainmentcard
+ - name: Expert Cadeaukaart
+ type: expertgiftcard
+ - name: FijnCadeau
+ type: fijncadeau
+ - name: Fleurop Bloemenbon
+ type: fleuropbloemenbon
+ - name: Gall & Gall
+ type: gallgall
+ - name: Generic GiftCard
+ type: genericgiftcard
+ - name: GiftFor2
+ type: giftfor2card
+ - name: Givex
+ type: givex
+ - name: Goldsmiths Card
+ type: goldsmithscard
+ - name: Hunkemoller Member Card
+ type: hmclub
+ - name: Phone Payment
+ type: ivr
+ - name: Landline phone
+ type: ivrLandline
+ - name: Mobile phone
+ type: ivrMobile
+ - name: Kado Wereld
+ type: kadowereld
+ - name: Karen Millen GiftCard
+ type: karenmillengiftcard
+ - name: Leisure Card
+ type: leisurecard
+ - name: Loods5 Cadeaukaart
+ type: loods5giftcard
+ - name: Loods5 Tegoedbon
+ type: loods5prepaidcard
+ - name: Amazon Pay
+ type: amazonpay
+ - name: MOLPoints
+ type: molpay_points
+ - name: Moneybookers
+ type: moneybookers
+ - name: De Nationale Musicalcard
+ type: musicalcard
+ - name: Nationale Bioscoopbon
+ type: nationalebioscoopbon
+ - name: Nationale Tuinbon
+ type: nationaletuinbon
+ - name: Nationale Verwen Cadeaubon
+ type: nationaleverwencadeaubon
+ - name: Onebip
+ type: onebip
+ - name: Google Pay
+ type: paywithgoogle
+ - name: Plastix
+ type: plastix
+ - name: Pluim
+ type: pluimgiftcard
+ - name: Illicado Gift Card
+ type: prosodie_illicado
+ - name: RatePay Invoice
+ type: ratepay
+ - name: Rob Peetoom Giftcard
+ type: robpeetoomgiftcard
+ - name: Shoes&Accessories Cadeau
+ type: sagiftcard
+ - name: Score Giftcard
+ type: scoregiftcard
+ - name: Premium SMS
+ type: sms
+ - name: SVS
+ type: svs
+ - name: TCS Test GiftCard
+ type: tcstestgiftcard
+ - name: The Sting Giftcard
+ type: thestinggiftcard
+ - name: Ukash
+ type: ukash
+ - name: UnionPay
+ type: unionpay
+ - name: Valuelink
+ type: valuelink
+ - name: V&D Cadeaukaart
+ type: vdcadeaucard
+ - name: Visa Checkout
+ type: visacheckout
+ - name: VVV Cadeaubon
+ type: vvvcadeaubon
+ - name: Webshop Giftcard
+ type: webshopgiftcard
+ - name: WE Fashion Giftcard
+ type: wefashiongiftcard
+ - name: Western Union
+ type: westernunion
+ - name: Winkel Cheque
+ type: winkelcheque
+ - name: Your Gift
+ type: yourgift
+ post-paymentMethods-include-stored:
+ summary: Get payment methods including stored card details
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ countryCode: NL
+ amount:
+ currency: EUR
+ value: 1000
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ post-paymentMethods-include-stored-200:
+ summary: Example response that includes stored payment methods
+ value:
+ paymentMethods:
+ - name: iDEAL
+ type: ideal
+ - name: Cards
+ type: scheme
+ - name: PayPal
+ type: paypal
+ - name: AfterPay Invoice
+ type: afterpay_default
+ - name: Pay later with Klarna.
+ type: klarna
+ - name: SEPA Direct Debit
+ type: sepadirectdebit
+ - name: Paysafecard
+ type: paysafecard
+ - name: Bijenkorf Cadeaucard
+ type: bijcadeaucard
+ - name: Fonq Giftcard
+ type: fonqgiftcard
+ - name: Bank Transfer (NL)
+ type: bankTransfer_NL
+ - name: Pathe Giftcard
+ type: pathegiftcard
+ - name: VVV Giftcard
+ type: vvvgiftcard
+ - name: Podium Card
+ type: podiumcard
+ - name: RatePay Direct Debit
+ type: ratepay_directdebit
+ - name: Rituals Giftcard
+ type: rituals
+ - name: Hunkemoller Lingerie Card
+ type: hmlingerie
+ - name: Primera Cadeaukaart
+ type: primeracadeaucard
+ - name: Fashioncheque
+ type: fashioncheque
+ - name: NETELLER
+ type: neteller
+ - name: Adyen Voucher
+ type: adyen_test_voucher
+ - name: AfterPay B2B
+ type: afterpay_b2b
+ - name: AfterPay DirectDebit
+ type: afterpay_directdebit
+ - name: AliPay
+ type: alipay
+ - name: AliPay
+ type: alipay_wap
+ - name: Android Pay
+ type: androidpay
+ - name: Apple Pay
+ type: applepay
+ - name: Baby Gift Card
+ type: babygiftcard
+ - name: SEPA Bank Transfer
+ type: bankTransfer_IBAN
+ - name: Bloemen Giftcard
+ type: bloemengiftcard
+ - name: Boekenbon Giftcard
+ type: boekenbon
+ - name: Cash-Ticket
+ type: cashticket
+ - name: Chasin Giftcard
+ type: chasingiftcard
+ - name: ClickandBuy
+ type: clickandbuy
+ - name: Costes Giftcard
+ type: costesgiftcard
+ - name: custom_settlement
+ type: custom_settlement
+ - name: eft_directdebit_CA
+ type: eft_directdebit_CA
+ - name: Nationale Entertainment Card
+ type: entertainmentcard
+ - name: Expert Cadeaukaart
+ type: expertgiftcard
+ - name: FijnCadeau
+ type: fijncadeau
+ - name: Fleurop Bloemenbon
+ type: fleuropbloemenbon
+ - name: Gall & Gall
+ type: gallgall
+ - name: Generic GiftCard
+ type: genericgiftcard
+ - name: GiftFor2
+ type: giftfor2card
+ - name: Givex
+ type: givex
+ - name: Goldsmiths Card
+ type: goldsmithscard
+ - name: Hunkemoller Member Card
+ type: hmclub
+ - name: Phone Payment
+ type: ivr
+ - name: Landline phone
+ type: ivrLandline
+ - name: Mobile phone
+ type: ivrMobile
+ - name: Kado Wereld
+ type: kadowereld
+ - name: Karen Millen GiftCard
+ type: karenmillengiftcard
+ - name: Leisure Card
+ type: leisurecard
+ - name: Loods5 Cadeaukaart
+ type: loods5giftcard
+ - name: Loods5 Tegoedbon
+ type: loods5prepaidcard
+ - name: Amazon Pay
+ type: amazonpay
+ - name: MOLPoints
+ type: molpay_points
+ - name: Moneybookers
+ type: moneybookers
+ - name: De Nationale Musicalcard
+ type: musicalcard
+ - name: Nationale Bioscoopbon
+ type: nationalebioscoopbon
+ - name: Nationale Tuinbon
+ type: nationaletuinbon
+ - name: Nationale Verwen Cadeaubon
+ type: nationaleverwencadeaubon
+ - name: Onebip
+ type: onebip
+ - name: Google Pay
+ type: paywithgoogle
+ - name: Plastix
+ type: plastix
+ - name: Pluim
+ type: pluimgiftcard
+ - name: Illicado Gift Card
+ type: prosodie_illicado
+ - name: RatePay Invoice
+ type: ratepay
+ - name: Rob Peetoom Giftcard
+ type: robpeetoomgiftcard
+ - name: Shoes&Accessories Cadeau
+ type: sagiftcard
+ - name: Score Giftcard
+ type: scoregiftcard
+ - name: Premium SMS
+ type: sms
+ - name: SVS
+ type: svs
+ - name: TCS Test GiftCard
+ type: tcstestgiftcard
+ - name: The Sting Giftcard
+ type: thestinggiftcard
+ - name: Ukash
+ type: ukash
+ - name: UnionPay
+ type: unionpay
+ - name: Valuelink
+ type: valuelink
+ - name: V&D Cadeaukaart
+ type: vdcadeaucard
+ - name: Visa Checkout
+ type: visacheckout
+ - name: VVV Cadeaubon
+ type: vvvcadeaubon
+ - name: Webshop Giftcard
+ type: webshopgiftcard
+ - name: WE Fashion Giftcard
+ type: wefashiongiftcard
+ - name: Western Union
+ type: westernunion
+ - name: Winkel Cheque
+ type: winkelcheque
+ - name: Your Gift
+ type: yourgift
+ storedPaymentMethods:
+ - brand: visa
+ expiryMonth: '10'
+ expiryYear: '30'
+ holderName: John Smith
+ id: '7219687191761347'
+ issuerName: ISSUER_NAME
+ lastFour: '1111'
+ name: VISA
+ shopperEmail: john.smith@example.com
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ supportedRecurringProcessingModels:
+ - CardOnFile
+ - Subscription
+ - UnscheduledCardOnFile
+ type: scheme
+ post-paymentSession-android:
+ summary: Set up a payment session (Android)
+ value:
+ amount:
+ currency: EUR
+ value: 17408
+ reference: Your order number
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ channel: Android
+ token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
+ returnUrl: app://
+ countryCode: NL
+ shopperLocale: nl_NL
+ sessionValidity: '2017-04-06T13:09:13Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentSession-enableOneClick:
+ summary: Set up a payment session with the option to store card details
+ value:
+ amount:
+ currency: EUR
+ value: 17408
+ reference: Your order number
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ enableOneClick: true
+ enableRecurring: true
+ channel: Web
+ origin: https://www.yourwebsite.com
+ returnUrl: https://www.yourshop.com/checkout/result
+ countryCode: NL
+ shopperLocale: nl_NL
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ sdkVersion: 1.7.0
+ post-paymentSession-enableOneClick-200:
+ summary: Example response for request 'enableOneClick'
+ value:
+ paymentSession: eyJjaGVja291dHNob3BwZXJCYXN...
+ post-paymentSession-ios:
+ summary: Set up a payment session (iOS)
+ value:
+ amount:
+ currency: EUR
+ value: 17408
+ reference: Your order number
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ channel: iOS
+ token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
+ returnUrl: app://
+ countryCode: NL
+ shopperLocale: nl_NL
+ sessionValidity: '2017-04-06T13:09:13Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentSession-split:
+ summary: Split a payment between a sub-merchant and a platform account
+ value:
+ amount:
+ currency: EUR
+ value: 6200
+ additionalData:
+ split.api: '1'
+ split.nrOfItems: '2'
+ split.totalAmount: '6200'
+ split.currencyCode: EUR
+ split.item1.amount: '6000'
+ split.item1.type: MarketPlace
+ split.item1.account: '151272963'
+ split.item1.reference: '6124145'
+ split.item1.description: 'Porcelain Doll: Eliza (20cm)'
+ split.item2.amount: '200'
+ split.item2.type: Commission
+ split.item2.reference: '6124146'
+ reference: Your order number
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ channel: Android
+ token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
+ returnUrl: app://
+ countryCode: NL
+ shopperLocale: nl_NL
+ sessionValidity: '2017-04-06T13:09:13Z'
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-paymentSession-web:
+ summary: Set up a payment session (Web)
+ value:
+ amount:
+ currency: EUR
+ value: 17408
+ reference: Your order number
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ channel: Web
+ origin: https://www.yourwebsite.com
+ returnUrl: https://www.yourshop.com/checkout/result
+ countryCode: NL
+ shopperLocale: nl_NL
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ sdkVersion: 1.9.5
+ post-paymentSession-web-200:
+ summary: Example response for request 'web'
+ value:
+ paymentSession: eyJjaGVja291dHNob3BwZXJCYXN...
+ post-payments-applepay:
+ summary: Make an Apple Pay payment
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: applepay
+ applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-card-3d-secure-2-web:
+ summary: Make a card payment with 3D Secure 2 native authentication
+ value:
+ amount:
+ currency: EUR
+ value: 1000
+ reference: YOUR_ORDER_NUMBER
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4035501428146300
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ holderName: John Smith
+ authenticationData:
+ threeDSRequestData:
+ nativeThreeDS: preferred
+ billingAddress:
+ country: US
+ city: New York
+ street: Redwood Block
+ houseNumberOrName: 37C
+ stateOrProvince: NY
+ postalCode: '10039'
+ shopperEmail: s.hopper@test.com
+ shopperIP: 192.0.2.1
+ browserInfo:
+ userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
+ (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36
+ acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
+ language: nl-NL
+ colorDepth: 24
+ screenHeight: 723
+ screenWidth: 1536
+ timeZoneOffset: 0
+ javaEnabled: true
+ channel: Web
+ origin: https://your-company.com
+ returnUrl: https://your-company.com/checkout/
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-card-3d-secure-direct:
+ summary: Make a card payment with 3D Secure redirect authentication
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ number: '4212345678901237'
+ expiryMonth: '03'
+ expiryYear: '2030'
+ holderName: John Smith
+ cvc: '737'
+ browserInfo:
+ userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912
+ Firefox/3.0
+ acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+ javaEnabled: true
+ colorDepth: 10
+ screenHeight: 2000
+ screenWidth: 3000
+ timeZoneOffset: 5
+ language: en
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-card-direct:
+ summary: Make a card payment with unencrypted card details
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ number: '4111111111111111'
+ expiryMonth: '03'
+ expiryYear: '2030'
+ holderName: John Smith
+ cvc: '737'
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-card-direct-200:
+ summary: Successful card payment with unencrypted card details
+ value:
+ additionalData:
+ cvcResult: 1 Matches
+ authCode: 044925
+ avsResult: 4 AVS not supported for this card type
+ avsResultRaw: '4'
+ cvcResultRaw: M
+ refusalReasonRaw: AUTHORISED
+ acquirerCode: TestPmmAcquirer
+ acquirerReference: 8PQMP9VEP3H
+ pspReference: 993617895204576J
+ resultCode: Authorised
+ merchantReference: string
+ post-payments-card-securedfields:
+ summary: Make a card payment
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4111111111111111
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-card-securedfields-200:
+ summary: Successful card payment
+ value:
+ additionalData:
+ cvcResult: 1 Matches
+ authCode: 065696
+ avsResult: 4 AVS not supported for this card type
+ avsResultRaw: '4'
+ cvcResultRaw: M
+ refusalReasonRaw: AUTHORISED
+ acquirerCode: TestPmmAcquirer
+ acquirerReference: 8PQMP9VIE9N
+ pspReference: 993617895215577D
+ resultCode: Authorised
+ merchantReference: string
+ post-payments-details-00.redirect:
+ summary: Submit the redirect result
+ description: Example request when submitting a redirect result
+ value:
+ details:
+ redirectResult: X6XtfGC3!Y...
+ post-payments-details-00.redirect-200:
+ summary: Payment authorised
+ description: Example response when submitting the redirect result
+ value:
+ resultCode: Authorised
+ pspReference: V4HZ4RBFJGXXGN82
+ post-payments-details-3d-secure-2-native:
+ summary: Submit 3D Secure 2 authentication result
+ value:
+ details:
+ threeDSResult: eyJ0cmFuc1N0YXR1cyI6IlkifQ==
+ post-payments-enableOneClick-SF:
+ summary: Tokenize card details for one-off payments
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4111111111111111
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ storePaymentMethod: true
+ shopperInteraction: Ecommerce
+ recurringProcessingModel: CardOnFile
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-enableOneClick-SF-200:
+ summary: Card details tokenized for one-off payments
+ value:
+ additionalData:
+ cvcResult: 1 Matches
+ authCode: 082338
+ avsResult: 4 AVS not supported for this card type
+ recurring.recurringDetailReference: '9916178934434753'
+ recurringProcessingModel: CardOnFile
+ avsResultRaw: '4'
+ cvcResultRaw: M
+ refusalReasonRaw: AUTHORISED
+ recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
+ acquirerCode: TestPmmAcquirer
+ acquirerReference: 8PQMP9VC172
+ pspReference: 993617895195570C
+ resultCode: Authorised
+ merchantReference: string
+ post-payments-googlepay:
+ summary: Make a Google Pay payment
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: paywithgoogle
+ googlePayToken: ==Payload as retrieved from Google Pay response==
+ returnUrl: https://your-company.com/...
+ merchantAccount: YourMerchantAccount
+ post-payments-ideal:
+ summary: Make an iDEAL payment
+ value:
+ amount:
+ currency: EUR
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: ideal
+ issuer: '1121'
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-ideal-200:
+ summary: Successful iDEAL payment
+ value:
+ resultCode: RedirectShopper
+ action:
+ paymentMethodType: ideal
+ url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ
+ method: GET
+ type: redirect
+ paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==
+ redirect:
+ method: GET
+ url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ
+ post-payments-klarna:
+ summary: Make a Klarna payment
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_ORDER_REFERENCE
+ paymentMethod:
+ type: klarna
+ amount:
+ currency: SEK
+ value: 1000
+ shopperLocale: en_US
+ countryCode: SE
+ telephoneNumber: +46 840 839 298
+ shopperEmail: youremail@email.com
+ shopperName:
+ firstName: Testperson-se
+ lastName: Approved
+ shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
+ billingAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ deliveryAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ returnUrl: https://www.your-company.com/...
+ lineItems:
+ - quantity: 1
+ amountExcludingTax: 331
+ taxPercentage: 2100
+ description: Shoes
+ id: 'Item #1'
+ taxAmount: 69
+ amountIncludingTax: 400
+ productUrl: URL_TO_PURCHASED_ITEM
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ - quantity: 2
+ amountExcludingTax: 248
+ taxPercentage: 2100
+ description: Socks
+ id: 'Item #2'
+ taxAmount: 52
+ amountIncludingTax: 300
+ productUrl: URL_TO_PURCHASED_ITEM
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ post-payments-oneclick-securedfields:
+ summary: Make a one-off payment with a token and CVV
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ storedPaymentMethodId: '8416038790273850'
+ encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH...
+ shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ shopperInteraction: ContAuth
+ recurringProcessingModel: CardOnFile
+ post-payments-paymentPspReference-amountUpdates-amount-update:
+ summary: Update the amount of an authorised payment
+ description: Example request to update the amount of a payment
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ amount:
+ currency: EUR
+ value: 2500
+ reference: YOUR_UNIQUE_REFERENCE
+ post-payments-paymentPspReference-amountUpdates-amount-update-201:
+ summary: Amount update requested
+ description: Example response when an amount update was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentPspReference: 993617894903480A
+ reference: YOUR_UNIQUE_REFERENCE
+ pspReference: 993617894906488A
+ status: received
+ amount:
+ currency: EUR
+ value: 2500
+ post-payments-paymentPspReference-cancels-cancel-with-psp-reference:
+ summary: Cancel payment using a PSP reference
+ description: Example cancel request with a PSP reference
+ value:
+ reference: YOUR_UNIQUE_REFERENCE
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201:
+ summary: Refund requested
+ description: Example response when a refund was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentPspReference: 993617894903480A
+ reference: YOUR_UNIQUE_REFERENCE
+ pspReference: 993617894906488A
+ status: received
+ post-payments-paymentPspReference-captures-capture:
+ summary: Capture an authorised payment
+ description: Example capture request
+ value:
+ reference: YOUR_UNIQUE_REFERENCE
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ amount:
+ value: 2000
+ currency: EUR
+ platformChargebackLogic:
+ behavior: deductFromOneBalanceAccount
+ targetAccount: BA00000000000000000000001
+ costAllocationAccount: BA00000000000000000000001
+ post-payments-paymentPspReference-captures-capture-201:
+ summary: Capture requested
+ description: Example response when a capture was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentPspReference: 993617894903480A
+ reference: YOUR_UNIQUE_REFERENCE
+ pspReference: 993617894906488A
+ status: received
+ amount:
+ value: 2000
+ currency: EUR
+ platformChargebackLogic:
+ behavior: deductFromOneBalanceAccount
+ targetAccount: BA00000000000000000000001
+ costAllocationAccount: BA00000000000000000000001
+ post-payments-paymentPspReference-refunds-refund:
+ summary: Refund a payment
+ description: Example refund request
+ value:
+ amount:
+ currency: EUR
+ value: 2500
+ reference: YOUR_UNIQUE_REFERENCE
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-paymentPspReference-refunds-refund-201:
+ summary: Refund requested
+ description: Example response when a refund was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentPspReference: 993617894903480A
+ reference: YOUR_UNIQUE_REFERENCE
+ pspReference: 993617894906488A
+ status: received
+ amount:
+ currency: EUR
+ value: 2500
+ post-payments-paymentPspReference-reversals-reversal:
+ summary: Reverse (cancel or refund) a payment
+ description: Example request to reverse a payment
+ value:
+ reference: YOUR_UNIQUE_REFERENCE
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-paymentPspReference-reversals-reversal-201:
+ summary: Payment reversal requested
+ description: Example response when a payment reversal was requested
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ paymentPspReference: 993617894903480A
+ reference: YOUR_UNIQUE_REFERENCE
+ pspReference: 993617894906488A
+ status: received
+ post-payments-recurring:
+ summary: Make a subscription card payment with a token
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ storedPaymentMethodId: '8316038796685850'
+ shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ shopperInteraction: ContAuth
+ recurringProcessingModel: Subscription
+ post-payments-result-basic:
+ summary: Verify payment results
+ value:
+ payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK
+ post-payments-result-basic-200:
+ summary: Payment authorised
+ value:
+ pspReference: V4HZ4RBFJGXXGN82
+ merchantReference: Your order number
+ shopperLocale: nl_NL
+ paymentMethod: ideal
+ post-payments-split-balanceplatform:
+ summary: Split a payment between balance accounts
+ value:
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4111111111111111
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ amount:
+ value: 40000
+ currency: USD
+ reference: YOUR_ORDER_NUMBER
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ returnUrl: https://your-company.com/...
+ platformChargebackLogic:
+ behavior: deductFromOneBalanceAccount
+ targetAccount: BA00000000000000000000001
+ costAllocationAccount: BA00000000000000000000001
+ splits:
+ - amount:
+ value: 39600
+ type: BalanceAccount
+ account: BA00000000000000000000001
+ reference: Your reference for the sale amount
+ description: Your description for the sale amount
+ - amount:
+ value: 400
+ type: Commission
+ reference: Your reference for the commission
+ description: Your description for the commission
+ - type: PaymentFee
+ account: BA00000000000000000000001
+ reference: Your reference for the fees
+ description: Your description for the fees
+ post-payments-split-balanceplatform-200:
+ summary: Payment split between balance accounts
+ value:
+ additionalData:
+ refusalReasonRaw: AUTHORISED
+ eci: N/A
+ acquirerAccountCode: YOUR_ACQUIRER_ACCOUNT
+ xid: N/A
+ threeDAuthenticated: 'false'
+ paymentMethodVariant: visa
+ issuerBin: '41111111'
+ payoutEligible: Y
+ fraudManualReview: 'false'
+ threeDOffered: 'false'
+ threeDOfferedResponse: N/A
+ authorisationMid: '50'
+ fundsAvailability: I
+ authorisedAmountCurrency: USD
+ threeDAuthenticatedResponse: N/A
+ avsResultRaw: '5'
+ retry.attempt1.rawResponse: AUTHORISED
+ paymentMethod: visa
+ avsResult: 5 No AVS data provided
+ cardSummary: '1111'
+ retry.attempt1.avsResultRaw: '5'
+ networkTxReference: '777718270854480'
+ expiryDate: 3/2030
+ cavvAlgorithm: N/A
+ cardBin: '411111'
+ alias: '8915844059375211'
+ cvcResultRaw: M
+ merchantReference: YOUR_ORDER_NUMBER
+ acquirerReference: YOUR_ACQUIRER_REFERENCE
+ cardIssuingCountry: NL
+ liabilityShift: 'false'
+ fraudResultType: GREEN
+ authCode: '035450'
+ cardHolderName: John Smith
+ isCardCommercial: unknown
+ PaymentAccountReference: 6006491286999921374...
+ retry.attempt1.acquirerAccount: YOUR_ACQUIRER_ACCOUNT
+ cardIssuingBank: ISSUING_BANK_CUSTOMER
+ retry.attempt1.acquirer: YOUR_ACQUIRER_CODE
+ authorisedAmountValue: '40000'
+ issuerCountry: NL
+ cvcResult: 1 Matches
+ retry.attempt1.responseCode: Approved
+ aliasType: Default
+ retry.attempt1.shopperInteraction: Ecommerce
+ cardPaymentMethod: visa
+ acquirerCode: YOUR_ACQUIRER_CODE
+ pspReference: PPKFQ89R6QRXGN82
+ resultCode: Authorised
+ amount:
+ currency: USD
+ value: 40000
+ donationToken: 81234567890123456...
+ merchantReference: YOUR_ORDER_NUMBER
+ paymentMethod:
+ brand: visa
+ type: scheme
+ post-payments-split-classic:
+ summary: Split a payment in a Classic Platforms integration
+ value:
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4111111111111111
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ amount:
+ value: 6200
+ currency: EUR
+ reference: YOUR_ORDER_NUMBER
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ returnUrl: https://your-company.com/...
+ splits:
+ - amount:
+ value: 6000
+ type: MarketPlace
+ account: '151272963'
+ reference: '6124145'
+ description: 'Porcelain Doll: Eliza (20cm)'
+ - amount:
+ value: 200
+ type: Commission
+ reference: '6124146'
+ post-payments-subscription-first-transaction:
+ summary: Tokenize card details for a subscription
+ value:
+ amount:
+ currency: USD
+ value: 1000
+ reference: Your order number
+ paymentMethod:
+ type: scheme
+ encryptedCardNumber: test_4111111111111111
+ encryptedExpiryMonth: test_03
+ encryptedExpiryYear: test_2030
+ encryptedSecurityCode: test_737
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ storePaymentMethod: true
+ shopperInteraction: Ecommerce
+ recurringProcessingModel: Subscription
+ returnUrl: https://your-company.com/...
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ post-payments-subscription-first-transaction-200:
+ summary: Card details tokenized for a subscription
+ value:
+ additionalData:
+ cvcResult: 1 Matches
+ authCode: 098871
+ avsResult: 4 AVS not supported for this card type
+ recurring.recurringDetailReference: '9916178934434753'
+ recurringProcessingModel: Subscription
+ avsResultRaw: '4'
+ cvcResultRaw: M
+ refusalReasonRaw: AUTHORISED
+ recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
+ acquirerCode: TestPmmAcquirer
+ acquirerReference: 8PQMP9VD896
+ pspReference: 993617895199574A
+ resultCode: Authorised
+ merchantReference: string
+ post-sessions-00.success:
+ summary: Create a payment session
+ description: Example request for creating a payment session
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ amount:
+ value: 100
+ currency: EUR
+ returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
+ reference: YOUR_PAYMENT_REFERENCE
+ countryCode: NL
+ post-sessions-00.success-201:
+ summary: 'Response code: 201. Success.'
+ description: Example response for creating a payment session
+ value:
+ amount:
+ currency: EUR
+ value: 100
+ countryCode: NL
+ expiresAt: '2022-01-11T13:53:18+01:00'
+ id: CS451F2AB1ED897A94
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_PAYMENT_REFERENCE
+ returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
+ sessionData: Ab02b4c0!BQABAgBfYI29...
+ post-sessions-01.klarna:
+ summary: Create a payment session including Klarna fields
+ description: Example request for creating a payment session when Klarna is one
+ of the available payment methods
+ value:
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_ORDER_REFERENCE
+ amount:
+ currency: SEK
+ value: 1000
+ shopperLocale: en_US
+ countryCode: SE
+ telephoneNumber: +46 840 839 298
+ shopperEmail: youremail@email.com
+ shopperName:
+ firstName: Testperson-se
+ lastName: Approved
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ billingAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ deliveryAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ dateOfBirth: '1996-09-04'
+ socialSecurityNumber: 0108
+ returnUrl: https://example.org
+ lineItems:
+ - quantity: 1
+ amountExcludingTax: 331
+ taxPercentage: 2100
+ description: Shoes
+ id: 'Item #1'
+ taxAmount: 69
+ amountIncludingTax: 400
+ productUrl: URL_TO_PURCHASED_ITEM
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ - quantity: 2
+ amountExcludingTax: 248
+ taxPercentage: 2100
+ description: Socks
+ id: 'Item #2'
+ taxAmount: 52
+ amountIncludingTax: 300
+ productUrl: URL_TO_PURCHASED_ITEM
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ post-sessions-01.klarna-201:
+ summary: 'Response code: 201. Success.'
+ description: 'Example '
+ value:
+ amount:
+ currency: SEK
+ value: 1000
+ billingAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ countryCode: SE
+ dateOfBirth: '1996-09-04T02:00:00+02:00'
+ deliveryAddress:
+ city: Ankeborg
+ country: SE
+ houseNumberOrName: '1'
+ postalCode: '12345'
+ street: Stargatan
+ expiresAt: '2022-01-11T13:57:52+01:00'
+ id: CSC52E9932D39ADAF3
+ lineItems:
+ - amountExcludingTax: 331
+ amountIncludingTax: 400
+ description: Shoes
+ id: 'Item #1'
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ productUrl: URL_TO_PURCHASED_ITEM
+ quantity: 1
+ taxAmount: 69
+ taxPercentage: 2100
+ - amountExcludingTax: 248
+ amountIncludingTax: 300
+ description: Socks
+ id: 'Item #2'
+ imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
+ productUrl: URL_TO_PURCHASED_ITEM
+ quantity: 2
+ taxAmount: 52
+ taxPercentage: 2100
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_ORDER_REFERENCE
+ returnUrl: https://example.org
+ shopperEmail: youremail@email.com
+ shopperLocale: en_US
+ shopperName:
+ firstName: Testperson-se
+ lastName: Approved
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ socialSecurityNumber: 0108
+ telephoneNumber: +46 840 839 298
+ sessionData: Ab02b4c0!BQABAgBfYI29...
+ post-sessions-enableOneClick:
+ summary: Tokenize card details for one-off payments without asking shopper
+ description: Example request for tokenizing card details for one-off payments
+ without asking shopper
+ value:
+ merchantAccount: TestMerchantCheckout
+ amount:
+ value: 100
+ currency: EUR
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
+ reference: YOUR_PAYMENT_REFERENCE
+ countryCode: NL
+ storePaymentMethodMode: enabled
+ shopperInteraction: Ecommerce
+ recurringProcessingModel: CardOnFile
+ post-sessions-enableOneClick-201:
+ summary: Shopper's payment details tokenized
+ description: Example response for tokenizing the shopper's payment details
+ value:
+ amount:
+ currency: EUR
+ value: 100
+ shopperReference: YOUR_SHOPPER_REFERENCE
+ countryCode: NL
+ expiresAt: '2022-01-11T13:56:05+01:00'
+ id: FJM726V375BV9D82
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ recurringProcessingModel: CardOnFile
+ reference: YOUR_PAYMENT_REFERENCE
+ returnUrl: https://your-company.com/checkout?shopperOrder=12xy..
+ shopperInteraction: Ecommerce
+ storePaymentMethod: true
+ sessionData: Ab02b4c0!BQABAgBfYI29...
+ post-sessions-split:
+ summary: Split a payment between balance accounts
+ value:
+ amount:
+ value: 40000
+ currency: USD
+ reference: YOUR_ORDER_NUMBER
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ returnUrl: https://your-company.com/...
+ splits:
+ - amount:
+ value: 39200
+ type: BalanceAccount
+ account: BA00000000000000000000001
+ reference: Your reference for the sale amount
+ description: Your description for the sale amount
+ - amount:
+ value: 400
+ type: Commission
+ reference: Your reference for the commission
+ description: Your description for the commission
+ - amount:
+ value: 400
+ account: BA00000000000000000000001
+ reference: Your reference for the fees
+ description: Your description for the fees
+ type: PaymentFee
+ post-sessions-split-201:
+ summary: Example response for request 'split'
+ value:
+ amount:
+ currency: USD
+ value: 40000
+ expiresAt: '2023-06-26T11:01:55+02:00'
+ id: CSFCBC80570618EF2C
+ merchantAccount: YOUR_MERCHANT_ACCOUNT
+ reference: YOUR_ORDER_NUMBER
+ returnUrl: https://your-company.com/...
+ shopperLocale: en-US
+ splits:
+ - account: BA00000000000000000000001
+ amount:
+ value: 39200
+ description: Your description for the sale amount
+ reference: Your reference for the sale amount
+ type: BalanceAccount
+ - amount:
+ value: 400
+ description: Your description for the commission
+ reference: Your reference for the commission
+ type: Commission
+ - amount:
+ value: 400
+ account: BA00000000000000000000001
+ description: Your description for the fees
+ reference: Your reference for the fees
+ type: PaymentFee
+ mode: embedded
+ sessionData: Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/JsonWithCommasInJsonExample.json b/modules/openapi-generator/src/test/resources/3_0/jetbrains/JsonWithCommasInJsonExample.json
new file mode 100644
index 000000000000..25942bcae80a
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/JsonWithCommasInJsonExample.json
@@ -0,0 +1,75 @@
+{
+ "openapi" : "3.1.0",
+ "info" : {
+ "description" : "Sample API",
+ "title" : "Basic",
+ "version" : "1.0"
+ },
+ "tags" : [ {
+ "description" : "Basic tag",
+ "name" : "basic"
+ } ],
+ "paths" : {
+ "/ws" : {
+ "post" : {
+ "description" : "Create",
+ "operationId" : "ws-post",
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "basic" : {
+ "$ref" : "#/components/examples/ex-1"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Item"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Item"
+ }
+ }
+ },
+ "description" : "Item created"
+ }
+ },
+ "summary" : "Create",
+ "tags" : [ "basic" ]
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "Item" : {
+ "description" : "",
+ "properties" : {
+ "id" : {
+ "description" : "Item id",
+ "type" : "integer"
+ },
+ "acceptHeader" : {
+ "type" : "string"
+ }
+ },
+ "title" : "item",
+ "type" : "object"
+ }
+ },
+ "examples": {
+ "ex-1": {
+ "summary" : "Example 1",
+ "value" : {
+ "id": 1,
+ "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/ManagementService-v3.json b/modules/openapi-generator/src/test/resources/3_0/jetbrains/ManagementService-v3.json
new file mode 100644
index 000000000000..74b530588bdb
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/ManagementService-v3.json
@@ -0,0 +1,28631 @@
+{
+ "openapi" : "3.1.0",
+ "servers" : [
+ {
+ "url" : "https://management-test.adyen.com/v3"
+ }
+ ],
+ "info" : {
+ "version" : "3",
+ "x-publicVersion" : true,
+ "title" : "Management API",
+ "description" : "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to this version of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v3/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v3\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/release-notes/management-api) to find out what changed in this version!",
+ "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
+ "contact" : {
+ "name" : "Adyen Developer Experience team",
+ "url" : "https://github.com/Adyen/adyen-openapi"
+ }
+ },
+ "tags" : [
+ {
+ "name" : "Account - company level"
+ },
+ {
+ "name" : "Account - merchant level"
+ },
+ {
+ "name" : "Account - store level"
+ },
+ {
+ "name" : "Payout settings - merchant level"
+ },
+ {
+ "name" : "Users - company level"
+ },
+ {
+ "name" : "Users - merchant level"
+ },
+ {
+ "name" : "My API credential"
+ },
+ {
+ "name" : "API credentials - company level"
+ },
+ {
+ "name" : "API credentials - merchant level"
+ },
+ {
+ "name" : "API key - company level"
+ },
+ {
+ "name" : "API key - merchant level"
+ },
+ {
+ "name" : "Client key - company level"
+ },
+ {
+ "name" : "Client key - merchant level"
+ },
+ {
+ "name" : "Allowed origins - company level"
+ },
+ {
+ "name" : "Allowed origins - merchant level"
+ },
+ {
+ "name" : "Webhooks - company level"
+ },
+ {
+ "name" : "Webhooks - merchant level"
+ },
+ {
+ "name" : "Payment methods - merchant level"
+ },
+ {
+ "name" : "Terminals - terminal level"
+ },
+ {
+ "name" : "Terminal actions - company level"
+ },
+ {
+ "name" : "Terminal actions - terminal level"
+ },
+ {
+ "name" : "Terminal orders - company level"
+ },
+ {
+ "name" : "Terminal orders - merchant level"
+ },
+ {
+ "name" : "Terminal settings - company level"
+ },
+ {
+ "name" : "Terminal settings - merchant level"
+ },
+ {
+ "name" : "Terminal settings - store level"
+ },
+ {
+ "name" : "Terminal settings - terminal level"
+ },
+ {
+ "name" : "Android files - company level"
+ },
+ {
+ "name" : "Split configuration - merchant level"
+ }
+ ],
+ "paths" : {
+ "/companies" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a list of company accounts",
+ "description" : "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read",
+ "operationId" : "get-companies",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listCompanyAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a company account",
+ "description" : "Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-companies-companyId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getCompanyAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Company"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidApps" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get a list of Android apps",
+ "description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-androidApps",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listAndroidApps",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The package name that uniquely identifies the Android app.",
+ "name" : "packageName",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The version number of the app.",
+ "name" : "versionCode",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-androidApps-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidAppsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Upload Android App",
+ "description" : "Uploads an Android APK file to Adyen.\nThe maximum APK file size is 200 MB.\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read and write\n\n>By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.",
+ "x-addedInVersion" : "3",
+ "operationId" : "post-companies-companyId-androidApps",
+ "x-sortIndex" : 4,
+ "x-methodName" : "uploadAndroidApp",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UploadAndroidAppResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidApps/{id}" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get Android app",
+ "description" : "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write",
+ "operationId" : "get-companies-companyId-androidApps-id",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getAndroidApp",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the app.",
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidApp"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidCertificates" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get a list of Android certificates",
+ "description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-androidCertificates",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAndroidCertificates",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The name of the certificate.",
+ "name" : "certificateName",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-androidCertificates-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidCertificatesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials" : {
+ "get" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Get a list of API credentials",
+ "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listApiCredentials",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyApiCredentialsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Create an API credential.",
+ "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-credential" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-post-company-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-credential" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-post-company-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyApiCredentialResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}" : {
+ "get" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Get an API credential",
+ "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Update an API credential.",
+ "description" : "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "patch-companies-companyId-apiCredentials-apiCredentialId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-credential" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-credential" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Get a list of allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origins" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Create an allowed origin",
+ "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Delete an allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "deleteAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Get an allowed origin",
+ "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origin" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey" : {
+ "post" : {
+ "tags" : [
+ "API key - company level"
+ ],
+ "summary" : "Generate new API key",
+ "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewApiKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateApiKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "Client key - company level"
+ ],
+ "summary" : "Generate new client key",
+ "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/billingEntities" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of billing entities",
+ "description" : "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-billingEntities",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listBillingEntities",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the billing entity.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-billingEntities-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/BillingEntitiesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/merchants" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a list of merchant accounts",
+ "description" : "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-companies-companyId-merchants",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listMerchantAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-merchants-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/shippingLocations" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of shipping locations",
+ "description" : "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-shippingLocations",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listShippingLocations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the shipping location.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of locations to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of locations to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-shippingLocations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocationsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Create a shipping location",
+ "description" : "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-companies-companyId-shippingLocations",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createShippingLocation",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalActions" : {
+ "get" : {
+ "tags" : [
+ "Terminal actions - company level"
+ ],
+ "summary" : "Get a list of terminal actions",
+ "description" : "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-terminalActions",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalActions",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "Returns terminal actions with the specified status. \nAllowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminal actions of the specified type. \nAllowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.",
+ "name" : "type",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalActions-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListExternalTerminalActionsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalActions/{actionId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal actions - company level"
+ ],
+ "summary" : "Get terminal action",
+ "description" : "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-terminalActions-actionId",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalAction",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the terminal action.",
+ "name" : "actionId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalActions-actionId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ExternalTerminalAction"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. \n\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-companies-companyId-terminalLogos",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). \n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the Adyen PSP level, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-companies-companyId-terminalLogos",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalModels" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of terminal models",
+ "description" : "Returns a list of payment terminal models that the company identified in the path has access to.\nThe response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalModels",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalModels",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalModels-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalModelsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of orders",
+ "description" : "Returns a lists of terminal products orders for the company identified in the path.\nTo filter the list, use one or more of the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalOrders",
+ "x-sortIndex" : 7,
+ "x-methodName" : "listOrders",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Your purchase order number.",
+ "name" : "customerOrderReference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of orders to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of orders to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalOrders-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrdersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Create an order",
+ "description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
+ "operationId" : "post-companies-companyId-terminalOrders",
+ "x-sortIndex" : 6,
+ "x-methodName" : "createOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-create-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-create-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders/{orderId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get an order",
+ "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalOrders-orderId",
+ "x-sortIndex" : 8,
+ "x-methodName" : "getOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalOrders-orderId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Update an order",
+ "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "patch-companies-companyId-terminalOrders-orderId",
+ "x-sortIndex" : 9,
+ "x-methodName" : "updateOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalOrders-orderId-update-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalOrders-orderId-update-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders/{orderId}/cancel" : {
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Cancel an order",
+ "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-companies-companyId-terminalOrders-orderId-cancel",
+ "x-sortIndex" : 10,
+ "x-methodName" : "cancelOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "cancel-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-orderId-cancel-cancel-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalProducts" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of terminal products",
+ "description" : "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.\n \nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalProducts",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listTerminalProducts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**",
+ "name" : "country",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**",
+ "name" : "terminalModelId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of products to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of products to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalProducts-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalProductsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-companies-companyId-terminalSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-companies-companyId-terminalSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/users" : {
+ "get" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Get a list of users",
+ "description" : "Returns the list of users for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-companies-companyId-users",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listUsers",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to return.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The partial or complete username to select all users that match.",
+ "name" : "username",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyUsersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Create a new user",
+ "description" : "Creates the user for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "post-companies-companyId-users",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createNewUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-companies-companyId-users-create-user"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-companies-companyId-users-create-user-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyUserResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/users/{userId}" : {
+ "get" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Get user details",
+ "description" : "Returns user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-companies-companyId-users-userId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Update user details",
+ "description" : "Updates user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "patch-companies-companyId-users-userId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks" : {
+ "get" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "List all webhooks",
+ "description" : "Lists all webhook configurations for the company account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-companies-companyId-webhooks",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAllWebhooks",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-company-webhooks" : {
+ "$ref" : "#/components/examples/get-companies-companyId-webhooks-get-company-webhooks-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListWebhooksResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Set up a webhook",
+ "description" : "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks",
+ "x-sortIndex" : 1,
+ "x-methodName" : "setUpWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-post-company-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-post-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}" : {
+ "delete" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Remove a webhook",
+ "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "delete-companies-companyId-webhooks-webhookId",
+ "x-sortIndex" : 5,
+ "x-methodName" : "removeWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Get a webhook",
+ "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-companies-companyId-webhooks-webhookId",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-company-webhook" : {
+ "$ref" : "#/components/examples/get-companies-companyId-webhooks-webhookId-get-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Update a webhook",
+ "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "patch-companies-companyId-webhooks-webhookId",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-webhook" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-webhooks-webhookId-patch-company-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-webhook" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-webhooks-webhookId-patch-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}/generateHmac" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Generate an HMAC key",
+ "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks-webhookId-generateHmac",
+ "x-sortIndex" : 6,
+ "x-methodName" : "generateHmacKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-generateHmac" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-generateHmac-post-company-webhook-generateHmac-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateHmacKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}/test" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Test a webhook",
+ "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks-webhookId-test",
+ "x-sortIndex" : 7,
+ "x-methodName" : "testWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-test" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-test" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me" : {
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get API credential details",
+ "description" : "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request.\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredentialDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/MeApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request.\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Add allowed origin",
+ "description" : "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "post-me-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "addAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateAllowedOriginRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Remove allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "delete-me-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "removeAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get allowed origin details",
+ "description" : "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOriginDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Generate a client key",
+ "description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-me-generateClientKey",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants" : {
+ "get" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Get a list of merchant accounts",
+ "description" : "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-merchants",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listMerchantAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Create a merchant account",
+ "description" : "Creates a merchant account for the company account specified in the request.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
+ "operationId" : "post-merchants",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchants" : {
+ "$ref" : "#/components/examples/post-merchants-post-merchants"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchants" : {
+ "$ref" : "#/components/examples/post-merchants-post-merchants-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}" : {
+ "get" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Get a merchant account",
+ "description" : "Returns the merchant account specified in the path. Your API credential must have access to the merchant account.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-merchants-merchantId",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Merchant"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/activate" : {
+ "post" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Request to activate a merchant account",
+ "description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
+ "operationId" : "post-merchants-merchantId-activate",
+ "x-sortIndex" : 2,
+ "x-methodName" : "requestToActivateMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RequestActivationResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials" : {
+ "get" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Get a list of API credentials",
+ "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listApiCredentials",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantApiCredentialsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Create an API credential",
+ "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential.\n\nThe response includes the:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-credential" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-post-merchant-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-credential" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-post-merchant-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateApiCredentialResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}" : {
+ "get" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Get an API credential",
+ "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Update an API credential",
+ "description" : "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "patch-merchants-merchantId-apiCredentials-apiCredentialId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-credential" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-credential" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Get a list of allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origin" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Create an allowed origin",
+ "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Delete an allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "deleteAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Get an allowed origin",
+ "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origins" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origins-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey" : {
+ "post" : {
+ "tags" : [
+ "API key - merchant level"
+ ],
+ "summary" : "Generate new API key",
+ "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewApiKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateApiKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "Client key - merchant level"
+ ],
+ "summary" : "Generate new client key",
+ "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/billingEntities" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of billing entities",
+ "description" : "Returns the billing entities of the merchant account identified in the path.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-billingEntities",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listBillingEntities",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the billing entity.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-billingEntities-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/BillingEntitiesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get all payment methods",
+ "description" : "Returns details for all payment methods of the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getAllPaymentMethods",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store for which to return the payment methods.",
+ "name" : "storeId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the Business Line for which to return the payment methods.",
+ "name" : "businessLineId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethodResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "429" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : ""
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Request a payment method",
+ "description" : "Sends a request to add a new payment method to the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "post-merchants-merchantId-paymentMethodSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "requestPaymentMethod",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-payment-method" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method"
+ },
+ "add-payment-method-partner-model" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethodSetupInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-payment-method" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method-200"
+ },
+ "add-payment-method-partner-model" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "429" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : ""
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get payment method details",
+ "description" : "Returns details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getPaymentMethodDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "429" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : ""
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Update a payment method",
+ "description" : "Updates payment method details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "patch-merchants-merchantId-paymentMethodSettings-paymentMethodId",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updatePaymentMethod",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdatePaymentMethodInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "429" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : ""
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains" : {
+ "post" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Add an Apple Pay domain",
+ "description" : "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains",
+ "x-sortIndex" : 5,
+ "x-methodName" : "addApplePayDomain",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-applepay-domain" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "429" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : ""
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get Apple Pay domains",
+ "description" : "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains",
+ "x-sortIndex" : 6,
+ "x-methodName" : "getApplePayDomains",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/payoutSettings" : {
+ "get" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Get a list of payout settings",
+ "description" : "Returns the list of payout settings for the merchant account identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read",
+ "operationId" : "get-merchants-merchantId-payoutSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listPayoutSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettingsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Add a payout setting",
+ "description" : "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.\n\nIf you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "post-merchants-merchantId-payoutSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "addPayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettingsRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}" : {
+ "delete" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Delete a payout setting",
+ "description" : "Deletes the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "delete-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-sortIndex" : 5,
+ "x-methodName" : "deletePayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Get a payout setting",
+ "description" : "Returns the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read",
+ "operationId" : "get-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getPayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Update a payout setting",
+ "description" : "Updates the payout setting identified in the path. You can enable or disable the payout setting.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "patch-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-sortIndex" : 2,
+ "x-methodName" : "updatePayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdatePayoutSettingsRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/shippingLocations" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of shipping locations",
+ "description" : "Returns the shipping locations for the merchant account identified in the path.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-shippingLocations",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listShippingLocations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the shipping location.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of locations to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of locations to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-shippingLocations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocationsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Create a shipping location",
+ "description" : "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-merchants-merchantId-shippingLocations",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createShippingLocation",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-shippingLocations-create-shipping-location"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-shippingLocations-create-shipping-location-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations" : {
+ "get" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Get a list of split configurations",
+ "description" : "Returns the list of split configurations for the merchant account.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "get-merchants-merchantId-splitConfigurations",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listSplitConfigurations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-splitConfigurations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfigurationList"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Create a split configuration",
+ "description" : "Creates a split configuration for the merchant account specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "post-merchants-merchantId-splitConfigurations",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-post-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-post-splitConfiguration-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}" : {
+ "delete" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Delete a split configuration",
+ "description" : "Deletes the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-sortIndex" : 8,
+ "x-methodName" : "deleteSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Get a split configuration",
+ "description" : "Returns the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "get-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-splitConfigurations-splitConfigurationId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update split configuration description",
+ "description" : "Changes the description of the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-sortIndex" : 5,
+ "x-methodName" : "updateSplitConfigurationDescription",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-description" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-description" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Create a rule",
+ "description" : "Creates a rule in the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "post-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-sortIndex" : 2,
+ "x-methodName" : "createRule",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfigurationRule"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}" : {
+ "delete" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Delete a split configuration rule",
+ "description" : "Deletes the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId",
+ "x-sortIndex" : 9,
+ "x-methodName" : "deleteSplitConfigurationRule",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update split conditions",
+ "description" : "Changes the conditions of the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId",
+ "x-sortIndex" : 6,
+ "x-methodName" : "updateSplitConditions",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationRuleRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration rule.",
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}" : {
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update the split logic",
+ "description" : "Changes the split logic specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId",
+ "x-sortIndex" : 7,
+ "x-methodName" : "updateSplitLogic",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule-splitLogic" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationLogicRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration rule.",
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration split.",
+ "name" : "splitLogicId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule-splitLogic" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a list of stores",
+ "description" : "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-merchants-merchantId-stores",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listStoresByMerchantId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The reference of the store.",
+ "name" : "reference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListStoresResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Create a store",
+ "description" : "Creates a store for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "post-merchants-merchantId-stores",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createStoreByMerchantId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-stores-post-stores"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/StoreCreationRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-stores-post-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{reference}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-stores-reference-terminalLogos",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-reference-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{reference}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-merchants-merchantId-stores-reference-terminalSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-reference-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{storeId}" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a store",
+ "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-merchants-merchantId-stores-storeId",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-storeId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Update a store",
+ "description" : "Updates the store identified in the path. You can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "patch-merchants-merchantId-stores-storeId",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateStoreRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-200"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-terminalLogos",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the company account, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-terminalLogos",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalModels" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of terminal models",
+ "description" : "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalModels",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalModels",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalModels-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalModelsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of orders",
+ "description" : "Returns a list of terminal products orders for the merchant account identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalOrders",
+ "x-sortIndex" : 7,
+ "x-methodName" : "listOrders",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Your purchase order number.",
+ "name" : "customerOrderReference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of orders to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of orders to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalOrders-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrdersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Create an order",
+ "description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
+ "operationId" : "post-merchants-merchantId-terminalOrders",
+ "x-sortIndex" : 6,
+ "x-methodName" : "createOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-create-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-create-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders/{orderId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get an order",
+ "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalOrders-orderId",
+ "x-sortIndex" : 8,
+ "x-methodName" : "getOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalOrders-orderId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Update an order",
+ "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
+ "x-sortIndex" : 9,
+ "x-methodName" : "updateOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalOrders-orderId-update-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalOrders-orderId-update-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders/{orderId}/cancel" : {
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Cancel an order",
+ "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel",
+ "x-sortIndex" : 10,
+ "x-methodName" : "cancelOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "cancel-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-orderId-cancel-cancel-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalProducts" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of terminal products",
+ "description" : "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalProducts",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listTerminalProducts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**",
+ "name" : "country",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**",
+ "name" : "terminalModelId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of products to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of products to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalProducts-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalProductsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-terminalSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the merchant account identified in the path.\nThese settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-terminalSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/users" : {
+ "get" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Get a list of users",
+ "description" : "Returns a list of users associated with the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-merchants-merchantId-users",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listUsers",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The partial or complete username to select all users that match.",
+ "name" : "username",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantUsersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Create a new user",
+ "description" : "Creates a user for the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "post-merchants-merchantId-users",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createNewUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-users-create-user"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-users-create-user-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateUserResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/users/{userId}" : {
+ "get" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Get user details",
+ "description" : "Returns user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-merchants-merchantId-users-userId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Update a user",
+ "description" : "Updates user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "patch-merchants-merchantId-users-userId",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks" : {
+ "get" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "List all webhooks",
+ "description" : "Lists all webhook configurations for the merchant account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-merchants-merchantId-webhooks",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAllWebhooks",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-merchant-webhooks" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-webhooks-get-merchant-webhooks-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListWebhooksResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Set up a webhook",
+ "description" : "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks",
+ "x-sortIndex" : 1,
+ "x-methodName" : "setUpWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-post-merchant-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-post-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}" : {
+ "delete" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Remove a webhook",
+ "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "delete-merchants-merchantId-webhooks-webhookId",
+ "x-sortIndex" : 5,
+ "x-methodName" : "removeWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Get a webhook",
+ "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-merchants-merchantId-webhooks-webhookId",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-merchant-webhook" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-webhooks-webhookId-get-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Update a webhook",
+ "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "patch-merchants-merchantId-webhooks-webhookId",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-webhook" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-webhook" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}/generateHmac" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Generate an HMAC key",
+ "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks-webhookId-generateHmac",
+ "x-sortIndex" : 6,
+ "x-methodName" : "generateHmacKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-generateHmac" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-generateHmac-post-merchant-webhook-generateHmac-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateHmacKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}/test" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Test a webhook",
+ "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks-webhookId-test",
+ "x-sortIndex" : 7,
+ "x-methodName" : "testWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-test" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-test" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a list of stores",
+ "description" : "Returns a list of stores. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-stores",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listStores",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The reference of the store.",
+ "name" : "reference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListStoresResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Create a store",
+ "description" : "Creates a store for the merchant account specified in the request.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "post-stores",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-stores-post-stores"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/StoreCreationWithMerchantCodeRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-stores-post-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a store",
+ "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-stores-storeId",
+ "x-sortIndex" : 6,
+ "x-methodName" : "getStoreById",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Update a store",
+ "description" : "Updates the store identified in the path.\nYou can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "patch-stores-storeId",
+ "x-sortIndex" : 7,
+ "x-methodName" : "updateStoreById",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateStoreRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-stores-storeId-terminalLogos",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogoByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-stores-storeId-terminalLogos",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogoByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-stores-storeId-terminalSettings",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettingsByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-stores-storeId-terminalSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettingsByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals" : {
+ "get" : {
+ "tags" : [
+ "Terminals - terminal level"
+ ],
+ "summary" : "Get a list of terminals",
+ "description" : "Returns the payment terminals that the API credential has access to and that match the query parameters. \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API — Terminal actions read",
+ "operationId" : "get-terminals",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminals",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.",
+ "name" : "searchQuery",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.",
+ "name" : "otpQuery",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).",
+ "name" : "countries",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.",
+ "name" : "merchantIds",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID.",
+ "name" : "storeIds",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*.",
+ "name" : "brandModels",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListTerminalsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/scheduleActions" : {
+ "post" : {
+ "tags" : [
+ "Terminal actions - terminal level"
+ ],
+ "summary" : "Create a terminal action",
+ "description" : "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. \n\nThe following restrictions apply:\n* You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. \n* The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. \n* If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read and write",
+ "operationId" : "post-terminals-scheduleActions",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createTerminalAction",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "install-app" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-install-app"
+ },
+ "uninstall-cert" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-uninstall-cert"
+ },
+ "verification-error" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-verification-error"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ScheduleTerminalActionsRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "install-app" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-install-app-200"
+ },
+ "uninstall-cert" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-uninstall-cert-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ScheduleTerminalActionsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "verification-error" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-verification-error-422"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/reassign" : {
+ "post" : {
+ "tags" : [
+ "Terminals - terminal level"
+ ],
+ "summary" : "Reassign a terminal",
+ "description" : "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Assign Terminal",
+ "x-addedInVersion" : "3",
+ "operationId" : "post-terminals-terminalId-reassign",
+ "x-sortIndex" : 2,
+ "x-methodName" : "reassignTerminal",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalReassignmentRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for the payment terminal identified in the path.\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-terminals-terminalId-terminalLogos",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-terminalId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Update the logo",
+ "description" : "Updates the logo for the payment terminal identified in the path.\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-terminals-terminalId-terminalLogos",
+ "x-sortIndex" : 6,
+ "x-methodName" : "updateLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the settings that are configured for the payment terminal identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-terminals-terminalId-terminalSettings",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-terminalId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates the settings that are configured for the payment terminal identified in the path.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-terminals-terminalId-terminalSettings",
+ "x-sortIndex" : 5,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "AdditionalCommission" : {
+ "properties" : {
+ "balanceAccountId" : {
+ "description" : "Unique identifier of the balance account to which the additional commission is booked.",
+ "type" : "string"
+ },
+ "fixedAmount" : {
+ "description" : "A fixed commission fee, in minor units.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "variablePercentage" : {
+ "description" : "A variable commission fee, in basis points.",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "AdditionalSettings" : {
+ "properties" : {
+ "includeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "properties" : {
+ "additionalProperties" : {
+ "type" : "boolean"
+ },
+ "description" : "Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled.\nFor example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured.",
+ "type" : "object"
+ }
+ },
+ "type" : "object"
+ },
+ "AdditionalSettingsResponse" : {
+ "properties" : {
+ "excludeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will not be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "includeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "properties" : {
+ "additionalProperties" : {
+ "type" : "boolean"
+ },
+ "description" : "Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled.\nFor example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured.",
+ "type" : "object"
+ }
+ },
+ "type" : "object"
+ },
+ "Address" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "companyName" : {
+ "description" : "The name of the company.",
+ "type" : "string"
+ },
+ "country" : {
+ "description" : "The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada. \n\nApplicable for the following countries:\n- Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ },
+ "streetAddress" : {
+ "description" : "The name of the street, and the house or building number.",
+ "type" : "string"
+ },
+ "streetAddress2" : {
+ "description" : "Additional address details, if any.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "AfterpayTouchInfo" : {
+ "properties" : {
+ "supportUrl" : {
+ "description" : "Support Url",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportUrl"
+ ],
+ "type" : "object"
+ },
+ "AllowedOrigin" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the allowed origin.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "domain" : {
+ "description" : "Domain of the allowed origin.",
+ "example" : "https://adyen.com",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the allowed origin.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "domain"
+ ],
+ "type" : "object"
+ },
+ "AllowedOriginsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of allowed origins.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Amount" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "value",
+ "currency"
+ ],
+ "type" : "object"
+ },
+ "AndroidApp" : {
+ "properties" : {
+ "description" : {
+ "description" : "The description that was provided when uploading the app. The description is not shown on the terminal.",
+ "type" : "string"
+ },
+ "errorCode" : {
+ "description" : "The error code of the app. It exists if the status is error or invalid.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the app.",
+ "type" : "string"
+ },
+ "label" : {
+ "description" : "The app name that is shown on the terminal.",
+ "type" : "string"
+ },
+ "packageName" : {
+ "description" : "The package name that uniquely identifies the Android app.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
+ "type" : "string"
+ },
+ "versionCode" : {
+ "description" : "The version number of the app.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "versionName" : {
+ "description" : "The app version number that is shown on the terminal.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "AndroidAppsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Apps uploaded for Android payment terminals.",
+ "items" : {
+ "$ref" : "#/components/schemas/AndroidApp"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "AndroidCertificate" : {
+ "properties" : {
+ "description" : {
+ "description" : "The description that was provided when uploading the certificate.",
+ "type" : "string"
+ },
+ "extension" : {
+ "description" : "The file format of the certificate, as indicated by the file extension. For example, **.cert** or **.pem**.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the certificate.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The file name of the certificate. For example, **mycert**.",
+ "type" : "string"
+ },
+ "notAfter" : {
+ "description" : "The date when the certificate stops to be valid.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "notBefore" : {
+ "description" : "The date when the certificate starts to be valid.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the certificate.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id"
+ ],
+ "type" : "object"
+ },
+ "AndroidCertificatesResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Uploaded Android certificates for Android payment terminals.",
+ "items" : {
+ "$ref" : "#/components/schemas/AndroidCertificate"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "ApiCredentialLinks" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "List of allowed origins.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "company" : {
+ "description" : "Company account that the API credential is linked to. Only present for company-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateApiKey" : {
+ "description" : "Generates a new API key. When you generate a new one, the existing key remains valid for 24 hours. ",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateClientKey" : {
+ "description" : "Generates a new client key, used to authenticate client-side requests. When you generate a new one, the existing key remains valid for 24 hours.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "merchant" : {
+ "description" : "The merchant account that the API credential is linked to. Only present for merchant-level API credentials.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "ApplePayInfo" : {
+ "properties" : {
+ "domains" : {
+ "description" : "The list of merchant domains. Maximum: 99 domains per request.\n\nFor more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live).",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "domains"
+ ],
+ "type" : "object"
+ },
+ "BcmcInfo" : {
+ "properties" : {
+ "enableBcmcMobile" : {
+ "description" : "Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled.",
+ "type" : "boolean"
+ },
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "BillingEntitiesResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of legal entities that can be used for the billing of orders.",
+ "items" : {
+ "$ref" : "#/components/schemas/BillingEntity"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "BillingEntity" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address details of the billing entity.",
+ "$ref" : "#/components/schemas/Address"
+ },
+ "email" : {
+ "description" : "The email address of the billing entity.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the billing entity, for use as `billingEntityId` when creating an order.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The unique name of the billing entity.",
+ "type" : "string"
+ },
+ "taxId" : {
+ "description" : "The tax number of the billing entity.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CardholderReceipt" : {
+ "properties" : {
+ "headerForAuthorizedReceipt" : {
+ "description" : "A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler`",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CartesBancairesInfo" : {
+ "properties" : {
+ "siret" : {
+ "description" : "Cartes Bancaires SIRET. Format: 14 digits.",
+ "type" : "string"
+ },
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "required" : [
+ "siret"
+ ],
+ "type" : "object"
+ },
+ "ClearpayInfo" : {
+ "properties" : {
+ "supportUrl" : {
+ "description" : "Support Url",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportUrl"
+ ],
+ "type" : "object"
+ },
+ "Commission" : {
+ "properties" : {
+ "fixedAmount" : {
+ "description" : "A fixed commission fee, in minor units.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "variablePercentage" : {
+ "description" : "A variable commission fee, in basis points.",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "Company" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this company.",
+ "$ref" : "#/components/schemas/CompanyLinks"
+ },
+ "dataCenters" : {
+ "description" : "List of available data centers.\n\nAdyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.",
+ "items" : {
+ "$ref" : "#/components/schemas/DataCenter"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description for the company account, maximum 300 characters",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The legal or trading name of the company.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to the account",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the company account.\n\nPossible values:\n\n* **Active**: Users can log in. Processing and payout capabilities depend on the status of the merchant account.\n* **Inactive**: Users can log in. Payment processing and payouts are disabled.\n* **Closed**: The company account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CompanyApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has explicit access to. \n If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "CompanyLinks" : {
+ "properties" : {
+ "apiCredentials" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "users" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "webhooks" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "CompanyUser" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "Configuration" : {
+ "properties" : {
+ "brand" : {
+ "description" : "Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). ",
+ "type" : "string"
+ },
+ "country" : {
+ "description" : "Countries, to filter different surcharge amounts for domestic or international cards.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "currencies" : {
+ "description" : "Currency, and surcharge percentage or amount.",
+ "items" : {
+ "$ref" : "#/components/schemas/Currency"
+ },
+ "type" : "array"
+ },
+ "sources" : {
+ "description" : "Funding source. Possible values:\n* **Credit**\n* **Debit**",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "brand",
+ "currencies"
+ ],
+ "type" : "object"
+ },
+ "Connectivity" : {
+ "properties" : {
+ "simcardStatus" : {
+ "description" : "Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity.\n\nPossible values:\n* **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings.\n* **INVENTORY**: the SIM card is not activated. The terminal can't use cellular connectivity.",
+ "enum" : [
+ "ACTIVATED",
+ "INVENTORY"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Contact" : {
+ "properties" : {
+ "email" : {
+ "description" : "The individual's email address.",
+ "type" : "string"
+ },
+ "firstName" : {
+ "description" : "The individual's first name.",
+ "type" : "string"
+ },
+ "infix" : {
+ "description" : "The infix in the individual's name, if any.",
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The individual's last name.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The individual's phone number, specified as 10-14 digits with an optional `+` prefix.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateAllowedOriginRequest" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the allowed origin.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "domain" : {
+ "description" : "Domain of the allowed origin.",
+ "example" : "https://adyen.com",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the allowed origin.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "domain"
+ ],
+ "type" : "object"
+ },
+ "CreateApiCredentialResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "apiKey" : {
+ "description" : "The API key for the API credential that was created.",
+ "type" : "string"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "The password for the API credential that was created.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active",
+ "password",
+ "apiKey"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyApiCredentialRequest" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateCompanyApiCredentialResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "apiKey" : {
+ "description" : "The API key for the API credential that was created.",
+ "type" : "string"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "The password for the API credential that was created.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active",
+ "password",
+ "apiKey",
+ "associatedMerchantAccounts"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.\n\nAllowed length: 1—80 characters.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The user's email address that will be their username. Must be the same as the one in the `email` field.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "email",
+ "username"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyUserResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are filtered when configuring the webhook. \n\nPossible values:\n* **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.\n* **includeAccounts** : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts** : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n\n",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "url",
+ "active",
+ "communicationFormat",
+ "type",
+ "filterMerchantAccountType",
+ "filterMerchantAccounts"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantApiCredentialRequest" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateMerchantRequest" : {
+ "properties" : {
+ "businessLineId" : {
+ "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration.",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "legalEntityId" : {
+ "description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). Required for an Adyen for Platforms Manage integration.",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Sets the pricing plan for the merchant account. Required for an Adyen for Platforms Manage integration. Your Adyen contact will provide the values that you can use.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference for the merchant account. To make this reference the unique identifier of the merchant account, your Adyen contact can set up a template on your company account. The template can have 6 to 255 characters with upper- and lower-case letters, underscores, and numbers. When your company account has a template, then the `reference` is required and must be unique within the company account.",
+ "type" : "string"
+ },
+ "salesChannels" : {
+ "description" : "List of sales channels that the merchant will process payments with",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "companyId"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantResponse" : {
+ "properties" : {
+ "businessLineId" : {
+ "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines).",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the merchant account. If Adyen set up a template for the `reference`, then the `id` will have the same value as the `reference` that you sent in the request. Otherwise, the value is generated by Adyen.",
+ "type" : "string"
+ },
+ "legalEntityId" : {
+ "description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Partner pricing plan for the merchant, applicable for merchants under AfP managed company accounts.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference for the merchant account.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateMerchantUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.\n\nAllowed length: 1—80 characters.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The user's email address that will be their username. Must be the same as the one in the `email` field.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "email",
+ "username"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "url",
+ "active",
+ "communicationFormat",
+ "type"
+ ],
+ "type" : "object"
+ },
+ "CreateUserResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "Currency" : {
+ "properties" : {
+ "amount" : {
+ "description" : "Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "currencyCode" : {
+ "description" : "Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**.",
+ "type" : "string"
+ },
+ "percentage" : {
+ "description" : "Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**.",
+ "format" : "double",
+ "type" : "number"
+ }
+ },
+ "required" : [
+ "currencyCode"
+ ],
+ "type" : "object"
+ },
+ "CustomNotification" : {
+ "properties" : {
+ "amount" : {
+ "description" : "The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "$ref" : "#/components/schemas/Amount"
+ },
+ "eventCode" : {
+ "description" : "The event that caused the notification to be sent.Currently supported values:\n* **AUTHORISATION**\n* **CANCELLATION**\n* **REFUND**\n* **CAPTURE**\n* **REPORT_AVAILABLE**\n* **CHARGEBACK**\n* **REQUEST_FOR_INFORMATION**\n* **NOTIFICATION_OF_CHARGEBACK**\n* **NOTIFICATIONTEST**\n* **ORDER_OPENED**\n* **ORDER_CLOSED**\n* **CHARGEBACK_REVERSED**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**",
+ "type" : "string"
+ },
+ "eventDate" : {
+ "description" : "The time of the event. Format: [ISO 8601](http://www.w3.org/TR/NOTE-datetime), YYYY-MM-DDThh:mm:ssTZD.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "merchantReference" : {
+ "description" : "Your reference for the custom test notification.",
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method for the payment that the notification is about. Possible values:\n* **amex**\n* **visa**\n* **mc**\n* **maestro**\n* **bcmc**\n* **paypal**\n * **sms**\n * **bankTransfer_NL**\n* **bankTransfer_DE**\n* **bankTransfer_BE**\n* **ideal**\n* **elv**\n* **sepadirectdebit**\n",
+ "type" : "string"
+ },
+ "reason" : {
+ "description" : "A descripton of what caused the notification.",
+ "type" : "string"
+ },
+ "success" : {
+ "description" : "The outcome of the event which the notification is about. Set to either **true** or **false**. ",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "DataCenter" : {
+ "properties" : {
+ "livePrefix" : {
+ "description" : "The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) for your live endpoint. Each data center has its own live URL prefix.\n\nThis field is empty for requests made in the test environment.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name assigned to a data center, for example **EU** for the European data center. Possible values are:\n\n* **default**: the European data center. This value is always returned in the test environment. \n* **AU**\n* **EU**\n* **US**",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "EventUrl" : {
+ "properties" : {
+ "eventLocalUrls" : {
+ "description" : "One or more local URLs to send event notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ },
+ "eventPublicUrls" : {
+ "description" : "One or more public URLs to send event notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ExternalTerminalAction" : {
+ "properties" : {
+ "actionType" : {
+ "description" : "The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, or **UninstallAndroidCertificate**.",
+ "type" : "string"
+ },
+ "config" : {
+ "description" : "Technical information about the terminal action.",
+ "type" : "string"
+ },
+ "confirmedAt" : {
+ "description" : "The date and time when the action was carried out.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique ID of the terminal action.",
+ "type" : "string"
+ },
+ "result" : {
+ "description" : "The result message for the action.",
+ "type" : "string"
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action was scheduled to happen.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the terminal action: **pending**, **successful**, **failed**, **cancelled**, or **tryLater**.",
+ "type" : "string"
+ },
+ "terminalId" : {
+ "description" : "The unique ID of the terminal that the action applies to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "File" : {
+ "properties" : {
+ "data" : {
+ "description" : "The certificate content converted to a Base64-encoded string.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the certificate. Must be unique across Wi-Fi profiles.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "data"
+ ],
+ "type" : "object"
+ },
+ "GenerateApiKeyResponse" : {
+ "properties" : {
+ "apiKey" : {
+ "description" : "The generated API key.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "apiKey"
+ ],
+ "type" : "object"
+ },
+ "GenerateClientKeyResponse" : {
+ "properties" : {
+ "clientKey" : {
+ "description" : "Generated client key",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "clientKey"
+ ],
+ "type" : "object"
+ },
+ "GenerateHmacKeyResponse" : {
+ "properties" : {
+ "hmacKey" : {
+ "description" : "The HMAC key generated for this webhook.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "hmacKey"
+ ],
+ "type" : "object"
+ },
+ "GenericPmWithTdiInfo" : {
+ "properties" : {
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "GiroPayInfo" : {
+ "properties" : {
+ "supportEmail" : {
+ "description" : "The email address of merchant support.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportEmail"
+ ],
+ "type" : "object"
+ },
+ "GooglePayInfo" : {
+ "properties" : {
+ "merchantId" : {
+ "description" : "Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters.",
+ "maxLength" : 20,
+ "minLength" : 16,
+ "type" : "string"
+ },
+ "reuseMerchantId" : {
+ "description" : "Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: **false**.",
+ "type" : "boolean"
+ }
+ },
+ "required" : [
+ "merchantId"
+ ],
+ "type" : "object"
+ },
+ "Gratuity" : {
+ "properties" : {
+ "allowCustomAmount" : {
+ "description" : "Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown.",
+ "type" : "boolean"
+ },
+ "currency" : {
+ "description" : "The currency that the tipping settings apply to.",
+ "type" : "string"
+ },
+ "predefinedTipEntries" : {
+ "description" : "Tipping options the shopper can choose from if `usePredefinedTipEntries` is **true**. The maximum number of predefined options is four, or three plus the option to enter a custom tip.\nThe options can be a mix of:\n\n- A percentage of the transaction amount. Example: **5%**\n- A tip amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "usePredefinedTipEntries" : {
+ "description" : "Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**).",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Hardware" : {
+ "properties" : {
+ "displayMaximumBackLight" : {
+ "description" : "The brightness of the display when the terminal is being used, expressed as a percentage.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "resetTotalsHour" : {
+ "description" : "The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "restartHour" : {
+ "description" : "The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "IdName" : {
+ "properties" : {
+ "id" : {
+ "description" : "The identifier of the terminal model.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the terminal model.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InstallAndroidAppDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "appId" : {
+ "description" : "The unique identifier of the app to be installed.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "InstallAndroidApp",
+ "description" : "Type of terminal action: Install an Android app.",
+ "enum" : [
+ "InstallAndroidApp"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InstallAndroidCertificateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "certificateId" : {
+ "description" : "The unique identifier of the certificate to be installed.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "InstallAndroidCertificate",
+ "description" : "Type of terminal action: Install an Android certificate.",
+ "enum" : [
+ "InstallAndroidCertificate"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InvalidField" : {
+ "properties" : {
+ "message" : {
+ "description" : "Description of the validation error.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The field that has an invalid value.",
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The invalid value.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "value",
+ "message"
+ ],
+ "type" : "object"
+ },
+ "JSONObject" : {
+ "type" : "object"
+ },
+ "Key" : {
+ "properties" : {
+ "identifier" : {
+ "description" : "The unique identifier of the shared key.",
+ "type" : "string"
+ },
+ "passphrase" : {
+ "description" : "The secure passphrase to protect the shared key.",
+ "type" : "string"
+ },
+ "version" : {
+ "description" : "The version number of the shared key.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "KlarnaInfo" : {
+ "properties" : {
+ "autoCapture" : {
+ "description" : "Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**.",
+ "type" : "boolean"
+ },
+ "disputeEmail" : {
+ "description" : "The email address for disputes.",
+ "type" : "string"
+ },
+ "region" : {
+ "description" : "The region of operation. For example, **NA**, **EU**, **CH**, **AU**.",
+ "enum" : [
+ "NA",
+ "EU",
+ "CH",
+ "AU"
+ ],
+ "maxLength" : 2,
+ "minLength" : 2,
+ "type" : "string"
+ },
+ "supportEmail" : {
+ "description" : "The email address of merchant support.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "region",
+ "supportEmail",
+ "disputeEmail"
+ ],
+ "type" : "object"
+ },
+ "Links" : {
+ "properties" : {
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "LinksElement" : {
+ "properties" : {
+ "href" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ListCompanyApiCredentialsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of API credentials.",
+ "items" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListCompanyResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of companies.",
+ "items" : {
+ "$ref" : "#/components/schemas/Company"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListCompanyUsersResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of users.",
+ "items" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListExternalTerminalActionsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The list of terminal actions.",
+ "items" : {
+ "$ref" : "#/components/schemas/ExternalTerminalAction"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ListMerchantApiCredentialsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of API credentials.",
+ "items" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListMerchantResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of merchant accounts.",
+ "items" : {
+ "$ref" : "#/components/schemas/Merchant"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListMerchantUsersResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of users.",
+ "items" : {
+ "$ref" : "#/components/schemas/User"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListStoresResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "List of stores",
+ "items" : {
+ "$ref" : "#/components/schemas/Store"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListTerminalsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of terminals and their details.",
+ "items" : {
+ "$ref" : "#/components/schemas/Terminal"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListWebhooksResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "accountReference" : {
+ "description" : "Reference to the account.",
+ "type" : "string"
+ },
+ "data" : {
+ "description" : "The list of webhooks configured for this account.",
+ "items" : {
+ "$ref" : "#/components/schemas/Webhook"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "Localization" : {
+ "properties" : {
+ "language" : {
+ "description" : "Language of the terminal.",
+ "type" : "string"
+ },
+ "secondaryLanguage" : {
+ "description" : "Secondary language of the terminal.",
+ "type" : "string"
+ },
+ "timezone" : {
+ "description" : "The time zone of the terminal.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Logo" : {
+ "properties" : {
+ "data" : {
+ "description" : "The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.",
+ "maxLength" : 350000,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "MeApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has explicit access to. \n If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "companyName" : {
+ "description" : "Name of the company linked to the API credential.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "MealVoucherFRInfo" : {
+ "properties" : {
+ "conecsId" : {
+ "description" : "Meal Voucher conecsId. Format: digits only",
+ "type" : "string"
+ },
+ "siret" : {
+ "description" : "Meal Voucher siret. Format: 14 digits.",
+ "maxLength" : 14,
+ "minLength" : 14,
+ "type" : "string"
+ },
+ "subTypes" : {
+ "description" : "The list of additional payment methods. Allowed values: **mealVoucher_FR_edenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "siret",
+ "conecsId",
+ "subTypes"
+ ],
+ "type" : "object"
+ },
+ "Merchant" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this merchant.",
+ "$ref" : "#/components/schemas/MerchantLinks"
+ },
+ "captureDelay" : {
+ "description" : "The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account.\n\nPossible values:\n* **Immediate**\n* **Manual**\n* Number of days from **1** to **29**",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account this merchant belongs to",
+ "type" : "string"
+ },
+ "dataCenters" : {
+ "description" : "List of available data centers.\n\nAdyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.",
+ "items" : {
+ "$ref" : "#/components/schemas/DataCenter"
+ },
+ "type" : "array"
+ },
+ "defaultShopperInteraction" : {
+ "description" : "The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the merchant account.",
+ "type" : "string"
+ },
+ "merchantCity" : {
+ "description" : "The city where the legal entity of this merchant account is registered.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the legal entity associated with the merchant account.",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.",
+ "type" : "string"
+ },
+ "primarySettlementCurrency" : {
+ "description" : "The currency of the country where the legal entity of this merchant account is registered. Format: [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, a legal entity based in the United States has USD as the primary settlement currency.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Reference of the merchant account.",
+ "type" : "string"
+ },
+ "shopWebAddress" : {
+ "description" : "The URL for the ecommerce website used with this merchant account.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the merchant account.\n\nPossible values:\n\n* **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments.\n* **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled.\n* **InactiveWithModifications**: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts.\n* **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled.\n* **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "MerchantLinks" : {
+ "properties" : {
+ "apiCredentials" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "users" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "webhooks" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "MinorUnitsMonetaryValue" : {
+ "properties" : {
+ "amount" : {
+ "description" : "The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "currencyCode" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Name" : {
+ "properties" : {
+ "firstName" : {
+ "description" : "The first name.",
+ "maxLength" : 80,
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The last name.",
+ "maxLength" : 80,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "firstName",
+ "lastName"
+ ],
+ "type" : "object"
+ },
+ "Name2" : {
+ "properties" : {
+ "firstName" : {
+ "description" : "The first name.",
+ "maxLength" : 80,
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The last name.",
+ "maxLength" : 80,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Nexo" : {
+ "properties" : {
+ "displayUrls" : {
+ "description" : "The list of local and public URLs to send display notifications to when using Terminal API.",
+ "$ref" : "#/components/schemas/NotificationUrl"
+ },
+ "encryptionKey" : {
+ "description" : "The key you share with Adyen to secure local communications when using Terminal API.",
+ "$ref" : "#/components/schemas/Key"
+ },
+ "eventUrls" : {
+ "description" : "The list of local and public URLs to send event notifications to when using Terminal API.",
+ "$ref" : "#/components/schemas/EventUrl"
+ },
+ "nexoEventUrls" : {
+ "deprecated" : true,
+ "x-deprecatedInVersion" : "1",
+ "x-deprecatedMessage" : "Use `eventUrls` instead.",
+ "description" : "One or more URLs to send event messages to when using Terminal API.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "notification" : {
+ "description" : "Configures sending event notifications by pressing a button on a terminal, for example used for pay-at-table.",
+ "$ref" : "#/components/schemas/Notification"
+ }
+ },
+ "type" : "object"
+ },
+ "Notification" : {
+ "properties" : {
+ "category" : {
+ "description" : "The type of event notification sent when you select the notification button.",
+ "enum" : [
+ "SaleWakeUp",
+ "KeyPressed",
+ ""
+ ],
+ "type" : "string"
+ },
+ "details" : {
+ "description" : "The text shown in the prompt which opens when you select the notification button. For example, the description of the input box for pay-at-table.",
+ "type" : "string"
+ },
+ "enabled" : {
+ "description" : "Enables sending event notifications either by pressing the Confirm key on terminals with a keypad or by tapping the event notification button on the terminal screen.",
+ "type" : "boolean"
+ },
+ "showButton" : {
+ "description" : "Shows or hides the event notification button on the screen of terminal models that have a keypad.",
+ "type" : "boolean"
+ },
+ "title" : {
+ "description" : "The name of the notification button on the terminal screen.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "NotificationUrl" : {
+ "properties" : {
+ "localUrls" : {
+ "description" : "One or more local URLs to send notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ },
+ "publicUrls" : {
+ "description" : "One or more public URLs to send notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "OfflineProcessing" : {
+ "properties" : {
+ "chipFloorLimit" : {
+ "description" : "The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "offlineSwipeLimits" : {
+ "description" : "The maximum offline transaction amount for swiped cards, in the specified currency.",
+ "items" : {
+ "$ref" : "#/components/schemas/MinorUnitsMonetaryValue"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Opi" : {
+ "properties" : {
+ "enablePayAtTable" : {
+ "description" : "Indicates if Pay at table is enabled.",
+ "type" : "boolean"
+ },
+ "payAtTableStoreNumber" : {
+ "description" : "The store number to use for Pay at Table.",
+ "type" : "string"
+ },
+ "payAtTableURL" : {
+ "description" : "The URL and port number used for Pay at Table communication.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "OrderItem" : {
+ "properties" : {
+ "id" : {
+ "description" : "The unique identifier of the product.",
+ "type" : "string"
+ },
+ "installments" : {
+ "description" : "The number of installments for the specified product `id`.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "name" : {
+ "description" : "The name of the product.",
+ "type" : "string"
+ },
+ "quantity" : {
+ "description" : "The number of items with the specified product `id` included in the order.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "PaginationLinks" : {
+ "properties" : {
+ "first" : {
+ "description" : "The first page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "last" : {
+ "description" : "The last page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "next" : {
+ "description" : "The next page. Only present if there is a next page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "prev" : {
+ "description" : "The previous page. Only present if there is a previous page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "The current page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self",
+ "first",
+ "last"
+ ],
+ "type" : "object"
+ },
+ "Passcodes" : {
+ "properties" : {
+ "adminMenuPin" : {
+ "description" : "The passcode for the Admin menu and the Settings menu.",
+ "maxLength" : 6,
+ "type" : "string"
+ },
+ "refundPin" : {
+ "description" : "The passcode for referenced and unreferenced refunds on standalone terminals.",
+ "maxLength" : 6,
+ "type" : "string"
+ },
+ "screenLockPin" : {
+ "description" : "The passcode to unlock the terminal screen after a timeout.",
+ "maxLength" : 6,
+ "minLength" : 4,
+ "type" : "string"
+ },
+ "txMenuPin" : {
+ "description" : "The passcode for the Transactions menu.",
+ "maxLength" : 6,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "PayAtTable" : {
+ "properties" : {
+ "authenticationMethod" : {
+ "description" : "Allowed authentication methods: Magswipe, Manual Entry.",
+ "enum" : [
+ "MAGSWIPE",
+ "MKE"
+ ],
+ "type" : "string"
+ },
+ "enablePayAtTable" : {
+ "description" : "Enable Pay at table.",
+ "type" : "boolean"
+ },
+ "paymentInstrument" : {
+ "description" : "Sets the allowed payment instrument for Pay at table transactions. Can be: **cash** or **card**. If not set, the terminal presents both options.",
+ "enum" : [
+ "Cash",
+ "Card"
+ ],
+ "nullable" : true,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "PayPalInfo" : {
+ "properties" : {
+ "directCapture" : {
+ "description" : "Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**.",
+ "type" : "boolean"
+ },
+ "payerId" : {
+ "description" : "PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.",
+ "maxLength" : 13,
+ "minLength" : 13,
+ "type" : "string"
+ },
+ "subject" : {
+ "description" : "Your business email address.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "subject",
+ "payerId"
+ ],
+ "type" : "object"
+ },
+ "Payment" : {
+ "properties" : {
+ "contactlessCurrency" : {
+ "description" : "The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "hideMinorUnitsInCurrencies" : {
+ "description" : "Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217).",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "PaymentMethod" : {
+ "properties" : {
+ "afterpayTouch" : {
+ "description" : "Afterpay Touch details.",
+ "$ref" : "#/components/schemas/AfterpayTouchInfo"
+ },
+ "allowed" : {
+ "description" : "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.",
+ "type" : "boolean"
+ },
+ "applePay" : {
+ "description" : "Apple Pay details.",
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ },
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "businessLineId" : {
+ "description" : "The unique identifier of the business line. Required if you have a [platform setup](https://docs.adyen.com/marketplaces-and-platforms/platform-structure-resources/platform-setup/).",
+ "type" : "string"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "clearpay" : {
+ "description" : "Clearpay details.",
+ "$ref" : "#/components/schemas/ClearpayInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "customRoutingFlags" : {
+ "description" : "The list of custom routing flags to route payment to the intended acquirer.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "enabled" : {
+ "description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
+ "type" : "boolean"
+ },
+ "giroPay" : {
+ "description" : "giropay details.",
+ "$ref" : "#/components/schemas/GiroPayInfo"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "googlePay" : {
+ "description" : "Google Pay details.",
+ "$ref" : "#/components/schemas/GooglePayInfo"
+ },
+ "id" : {
+ "description" : "The identifier of the resource.",
+ "type" : "string"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "klarna" : {
+ "description" : "Klarna details.",
+ "$ref" : "#/components/schemas/KlarnaInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mealVoucher_FR" : {
+ "description" : "Meal Voucher FR details.",
+ "$ref" : "#/components/schemas/MealVoucherFRInfo"
+ },
+ "paypal" : {
+ "description" : "PayPal details.",
+ "$ref" : "#/components/schemas/PayPalInfo"
+ },
+ "reference" : {
+ "description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
+ "maxLength" : 150,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel.",
+ "type" : "string"
+ },
+ "sofort" : {
+ "description" : "Sofort details.",
+ "$ref" : "#/components/schemas/SofortInfo"
+ },
+ "storeIds" : {
+ "x-addedInVersion" : "3",
+ "description" : "The unique identifier of the store for which to configure the payment method, if any.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "swish" : {
+ "description" : "Swish details.",
+ "$ref" : "#/components/schemas/SwishInfo"
+ },
+ "twint" : {
+ "description" : "Twint details.",
+ "$ref" : "#/components/schemas/TwintInfo"
+ },
+ "type" : {
+ "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
+ "type" : "string"
+ },
+ "verificationStatus" : {
+ "description" : "Payment method status. Possible values:\n* **valid**\n* **pending**\n* **invalid**\n* **rejected**",
+ "enum" : [
+ "valid",
+ "pending",
+ "invalid",
+ "rejected"
+ ],
+ "type" : "string"
+ },
+ "vipps" : {
+ "description" : "Vipps details.",
+ "$ref" : "#/components/schemas/VippsInfo"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "required" : [
+ "id"
+ ],
+ "type" : "object"
+ },
+ "PaymentMethodResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of supported payment methods and their details.",
+ "items" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "typesWithErrors" : {
+ "description" : "Payment method types with errors.",
+ "items" : {
+ "enum" : [
+ "afterpaytouch",
+ "alipay",
+ "alipay_hk",
+ "amex",
+ "applepay",
+ "bcmc",
+ "blik",
+ "cartebancaire",
+ "clearpay",
+ "cup",
+ "diners",
+ "directdebit_GB",
+ "discover",
+ "ebanking_FI",
+ "eftpos_australia",
+ "elo",
+ "elocredit",
+ "elodebit",
+ "girocard",
+ "googlepay",
+ "hiper",
+ "hipercard",
+ "ideal",
+ "interac_card",
+ "jcb",
+ "klarna",
+ "klarna_account",
+ "klarna_paynow",
+ "maestro",
+ "mbway",
+ "mc",
+ "mcdebit",
+ "mealVoucher_FR",
+ "mobilepay",
+ "multibanco",
+ "onlineBanking_PL",
+ "paybybank",
+ "paypal",
+ "payshop",
+ "swish",
+ "trustly",
+ "twint",
+ "twint_pos",
+ "vipps",
+ "visa",
+ "visadebit",
+ "vpay",
+ "wechatpay",
+ "wechatpay_pos"
+ ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "PaymentMethodSetupInfo" : {
+ "properties" : {
+ "afterpayTouch" : {
+ "description" : "Afterpay Touch details.",
+ "$ref" : "#/components/schemas/AfterpayTouchInfo"
+ },
+ "applePay" : {
+ "description" : "Apple Pay details.",
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ },
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "businessLineId" : {
+ "description" : "The unique identifier of the business line. Required if you have a [platform setup](https://docs.adyen.com/marketplaces-and-platforms/platform-structure-resources/platform-setup/).",
+ "type" : "string"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "clearpay" : {
+ "description" : "Clearpay details.",
+ "$ref" : "#/components/schemas/ClearpayInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "customRoutingFlags" : {
+ "description" : "The list of custom routing flags to route payment to the intended acquirer.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "giroPay" : {
+ "description" : "giropay details.",
+ "$ref" : "#/components/schemas/GiroPayInfo"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "googlePay" : {
+ "description" : "Google Pay details.",
+ "$ref" : "#/components/schemas/GooglePayInfo"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "klarna" : {
+ "description" : "Klarna details.",
+ "$ref" : "#/components/schemas/KlarnaInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mealVoucher_FR" : {
+ "description" : "Meal Voucher FR details.",
+ "$ref" : "#/components/schemas/MealVoucherFRInfo"
+ },
+ "paypal" : {
+ "description" : "PayPal details.",
+ "$ref" : "#/components/schemas/PayPalInfo"
+ },
+ "reference" : {
+ "description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
+ "maxLength" : 150,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.\n\nPossible values: **eCommerce**, **pos**, **contAuth**, and **moto**. ",
+ "enum" : [
+ "eCommerce",
+ "pos",
+ "moto",
+ "contAuth"
+ ],
+ "type" : "string"
+ },
+ "sofort" : {
+ "description" : "Sofort details.",
+ "$ref" : "#/components/schemas/SofortInfo"
+ },
+ "storeIds" : {
+ "x-addedInVersion" : "3",
+ "description" : "The unique identifier of the store for which to configure the payment method, if any.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "swish" : {
+ "description" : "Swish details.",
+ "$ref" : "#/components/schemas/SwishInfo"
+ },
+ "twint" : {
+ "description" : "Twint details.",
+ "$ref" : "#/components/schemas/TwintInfo"
+ },
+ "type" : {
+ "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
+ "enum" : [
+ "afterpaytouch",
+ "alipay",
+ "alipay_hk",
+ "amex",
+ "applepay",
+ "bcmc",
+ "blik",
+ "cartebancaire",
+ "clearpay",
+ "cup",
+ "diners",
+ "directdebit_GB",
+ "discover",
+ "ebanking_FI",
+ "eftpos_australia",
+ "elo",
+ "elocredit",
+ "elodebit",
+ "girocard",
+ "googlepay",
+ "hiper",
+ "hipercard",
+ "ideal",
+ "interac_card",
+ "jcb",
+ "klarna",
+ "klarna_account",
+ "klarna_paynow",
+ "maestro",
+ "mbway",
+ "mc",
+ "mcdebit",
+ "mealVoucher_FR",
+ "mobilepay",
+ "multibanco",
+ "onlineBanking_PL",
+ "paybybank",
+ "paypal",
+ "payshop",
+ "swish",
+ "trustly",
+ "twint",
+ "twint_pos",
+ "vipps",
+ "visa",
+ "visadebit",
+ "vpay",
+ "wechatpay",
+ "wechatpay_pos"
+ ],
+ "type" : "string"
+ },
+ "vipps" : {
+ "description" : "Vipps details.",
+ "$ref" : "#/components/schemas/VippsInfo"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "required" : [
+ "type"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettings" : {
+ "properties" : {
+ "allowed" : {
+ "description" : "Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:\n\n* **true** if `verificationStatus` is **valid**.\n* **false** for all other values.",
+ "type" : "boolean"
+ },
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ },
+ "enabledFromDate" : {
+ "description" : "The date when Adyen starts paying out to this bank account.\n\nFormat: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.\n\nIf not specified, the `enabled` field indicates if payouts are enabled for this bank account.\n\nIf a date is specified and:\n\n* `enabled`: **true**, payouts are enabled starting the specified date.\n* `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the payout setting.",
+ "type" : "string"
+ },
+ "priority" : {
+ "description" : "Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account.\n\n Possible values:\n* **first**: same day.\n* **urgent**: the next day.\n* **normal**: between 1 and 3 days.",
+ "enum" : [
+ "first",
+ "normal",
+ "urgent"
+ ],
+ "type" : "string"
+ },
+ "transferInstrumentId" : {
+ "description" : "The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.",
+ "type" : "string"
+ },
+ "verificationStatus" : {
+ "description" : "The status of the verification process for the bank account.\n\nPossible values:\n* **valid**: the verification was successful.\n* **pending**: the verification is in progress.\n* **invalid**: the information provided is not complete.\n* **rejected**: there are reasons to refuse working with this entity.",
+ "enum" : [
+ "invalid",
+ "pending",
+ "rejected",
+ "valid"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "transferInstrumentId",
+ "id"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettingsRequest" : {
+ "properties" : {
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ },
+ "enabledFromDate" : {
+ "description" : "The date when Adyen starts paying out to this bank account.\n\nFormat: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.\n\nIf not specified, the `enabled` field indicates if payouts are enabled for this bank account.\n\nIf a date is specified and:\n\n* `enabled`: **true**, payouts are enabled starting the specified date.\n* `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.",
+ "type" : "string"
+ },
+ "transferInstrumentId" : {
+ "description" : "The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "transferInstrumentId"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettingsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The list of payout accounts.",
+ "items" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Profile" : {
+ "properties" : {
+ "authType" : {
+ "description" : "The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**.",
+ "type" : "string"
+ },
+ "autoWifi" : {
+ "description" : "Indicates whether to automatically select the best authentication method available. Does not work on older terminal models.",
+ "type" : "boolean"
+ },
+ "bssType" : {
+ "description" : "Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations.",
+ "type" : "string"
+ },
+ "channel" : {
+ "description" : "The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "defaultProfile" : {
+ "description" : "Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first.",
+ "type" : "boolean"
+ },
+ "eap" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast**",
+ "type" : "string"
+ },
+ "eapCaCert" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. The root certificate from the CA that signed the certificate of the RADIUS server that is part of your wireless network.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientCert" : {
+ "description" : "For `eap` **tls**. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientKey" : {
+ "description" : "For `eap` **tls**. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientPwd" : {
+ "description" : "For `eap` **tls**. The password of the RSA key file, if that file is password-protected.",
+ "type" : "string"
+ },
+ "eapIdentity" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.",
+ "type" : "string"
+ },
+ "eapIntermediateCert" : {
+ "description" : "For `eap` **tls**. The EAP intermediate certificate.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapPwd" : {
+ "description" : "For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.",
+ "type" : "string"
+ },
+ "hiddenSsid" : {
+ "description" : "Indicates if the network doesn't broadcast its SSID. Mandatory for Android terminals, because these terminals rely on this setting to be able to connect to any network.",
+ "type" : "boolean"
+ },
+ "name" : {
+ "description" : "Your name for the Wi-Fi profile.",
+ "type" : "string"
+ },
+ "psk" : {
+ "description" : "For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network.",
+ "type" : "string"
+ },
+ "ssid" : {
+ "description" : "The name of the wireless network.",
+ "type" : "string"
+ },
+ "wsec" : {
+ "description" : "The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip**",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "ssid",
+ "bssType",
+ "authType",
+ "wsec"
+ ],
+ "type" : "object"
+ },
+ "ReceiptOptions" : {
+ "properties" : {
+ "logo" : {
+ "description" : "The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.",
+ "maxLength" : 350000,
+ "type" : "string"
+ },
+ "promptBeforePrinting" : {
+ "description" : "Indicates whether a screen appears asking if you want to print the shopper receipt.",
+ "type" : "boolean"
+ },
+ "qrCodeData" : {
+ "description" : "Data to print on the receipt as a QR code. This can include static text and the following variables:\n\n- `${merchantreference}`: the merchant reference of the transaction.\n- `${pspreference}`: the PSP reference of the transaction.\n\n For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ReceiptPrinting" : {
+ "properties" : {
+ "merchantApproved" : {
+ "description" : "Print a merchant receipt when the payment is approved.",
+ "type" : "boolean"
+ },
+ "merchantCancelled" : {
+ "description" : "Print a merchant receipt when the transaction is cancelled.",
+ "type" : "boolean"
+ },
+ "merchantCaptureApproved" : {
+ "description" : "Print a merchant receipt when capturing the payment is approved.",
+ "type" : "boolean"
+ },
+ "merchantCaptureRefused" : {
+ "description" : "Print a merchant receipt when capturing the payment is refused.",
+ "type" : "boolean"
+ },
+ "merchantRefundApproved" : {
+ "description" : "Print a merchant receipt when the refund is approved.",
+ "type" : "boolean"
+ },
+ "merchantRefundRefused" : {
+ "description" : "Print a merchant receipt when the refund is refused.",
+ "type" : "boolean"
+ },
+ "merchantRefused" : {
+ "description" : "Print a merchant receipt when the payment is refused.",
+ "type" : "boolean"
+ },
+ "merchantVoid" : {
+ "description" : "Print a merchant receipt when a previous transaction is voided.",
+ "type" : "boolean"
+ },
+ "shopperApproved" : {
+ "description" : "Print a shopper receipt when the payment is approved.",
+ "type" : "boolean"
+ },
+ "shopperCancelled" : {
+ "description" : "Print a shopper receipt when the transaction is cancelled.",
+ "type" : "boolean"
+ },
+ "shopperCaptureApproved" : {
+ "description" : "Print a shopper receipt when capturing the payment is approved.",
+ "type" : "boolean"
+ },
+ "shopperCaptureRefused" : {
+ "description" : "Print a shopper receipt when capturing the payment is refused.",
+ "type" : "boolean"
+ },
+ "shopperRefundApproved" : {
+ "description" : "Print a shopper receipt when the refund is approved.",
+ "type" : "boolean"
+ },
+ "shopperRefundRefused" : {
+ "description" : "Print a shopper receipt when the refund is refused.",
+ "type" : "boolean"
+ },
+ "shopperRefused" : {
+ "description" : "Print a shopper receipt when the payment is refused.",
+ "type" : "boolean"
+ },
+ "shopperVoid" : {
+ "description" : "Print a shopper receipt when a previous transaction is voided.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Referenced" : {
+ "properties" : {
+ "enableStandaloneRefunds" : {
+ "description" : "Indicates whether referenced refunds are enabled on the standalone terminal.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Refunds" : {
+ "properties" : {
+ "referenced" : {
+ "description" : "Settings for referenced refunds.",
+ "$ref" : "#/components/schemas/Referenced"
+ }
+ },
+ "type" : "object"
+ },
+ "ReleaseUpdateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "type" : {
+ "default" : "ReleaseUpdate",
+ "description" : "Type of terminal action: Update Release.",
+ "enum" : [
+ "ReleaseUpdate"
+ ],
+ "type" : "string"
+ },
+ "updateAtFirstMaintenanceCall" : {
+ "description" : "Boolean flag that tells if the terminal should update at the first next maintenance call. If false, terminal will update on its configured reboot time.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "RequestActivationResponse" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account you requested to activate.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "RestServiceError" : {
+ "properties" : {
+ "detail" : {
+ "description" : "A human-readable explanation specific to this occurrence of the problem.",
+ "type" : "string"
+ },
+ "errorCode" : {
+ "description" : "A code that identifies the problem type.",
+ "type" : "string"
+ },
+ "instance" : {
+ "description" : "A unique URI that identifies the specific occurrence of the problem.",
+ "type" : "string"
+ },
+ "invalidFields" : {
+ "description" : "Detailed explanation of each validation error, when applicable.",
+ "items" : {
+ "$ref" : "#/components/schemas/InvalidField"
+ },
+ "type" : "array"
+ },
+ "requestId" : {
+ "description" : "A unique reference for the request, essentially the same as `pspReference`.",
+ "type" : "string"
+ },
+ "response" : {
+ "description" : "JSON response payload.",
+ "$ref" : "#/components/schemas/JSONObject"
+ },
+ "status" : {
+ "description" : "The HTTP status code.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "title" : {
+ "description" : "A short, human-readable summary of the problem type.",
+ "type" : "string"
+ },
+ "type" : {
+ "description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "type",
+ "errorCode",
+ "title",
+ "detail",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "ScheduleTerminalActionsRequest" : {
+ "properties" : {
+ "actionDetails" : {
+ "description" : "Information about the action to take.",
+ "oneOf" : [
+ {
+ "$ref" : "#/components/schemas/InstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/InstallAndroidCertificateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/ReleaseUpdateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidCertificateDetails"
+ }
+ ]
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.",
+ "type" : "string"
+ },
+ "terminalIds" : {
+ "description" : "A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ScheduleTerminalActionsResponse" : {
+ "properties" : {
+ "actionDetails" : {
+ "description" : "Information about the action to take.",
+ "oneOf" : [
+ {
+ "$ref" : "#/components/schemas/InstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/InstallAndroidCertificateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/ReleaseUpdateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidCertificateDetails"
+ }
+ ]
+ },
+ "items" : {
+ "x-addedInVersion" : "1",
+ "description" : "A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalActionScheduleDetail"
+ },
+ "type" : "array"
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.",
+ "type" : "string"
+ },
+ "terminalsWithErrors" : {
+ "additionalProperties" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : "The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.",
+ "type" : "object"
+ },
+ "totalErrors" : {
+ "description" : "The number of terminals for which scheduling the action failed.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "totalScheduled" : {
+ "description" : "The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "Settings" : {
+ "properties" : {
+ "band" : {
+ "description" : "The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.",
+ "type" : "string"
+ },
+ "roaming" : {
+ "description" : "Indicates whether roaming is enabled on the terminals.",
+ "type" : "boolean"
+ },
+ "timeout" : {
+ "description" : "The connection time-out in seconds. Minimum value: 0.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "ShippingLocation" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address details of the shipping location.",
+ "$ref" : "#/components/schemas/Address"
+ },
+ "contact" : {
+ "description" : "The contact details for the shipping location.",
+ "$ref" : "#/components/schemas/Contact"
+ },
+ "id" : {
+ "description" : "The unique identifier of the shipping location, for use as `shippingLocationId` when creating an order.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The unique name of the shipping location.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ShippingLocationsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Physical locations where orders can be shipped to.",
+ "items" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Signature" : {
+ "properties" : {
+ "askSignatureOnScreen" : {
+ "description" : "If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**).",
+ "type" : "boolean"
+ },
+ "deviceName" : {
+ "description" : "Name that identifies the terminal.",
+ "type" : "string"
+ },
+ "deviceSlogan" : {
+ "description" : "Slogan shown on the start screen of the device.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "skipSignature" : {
+ "description" : "Skip asking for a signature. This is possible because all global card schemes (American Express, Diners, Discover, JCB, MasterCard, VISA, and UnionPay) regard a signature as optional.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "SofortInfo" : {
+ "properties" : {
+ "currencyCode" : {
+ "description" : "Sofort currency code. For example, **EUR**.",
+ "type" : "string"
+ },
+ "logo" : {
+ "description" : "Sofort logo. Format: Base64-encoded string.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo",
+ "currencyCode"
+ ],
+ "type" : "object"
+ },
+ "SplitConfiguration" : {
+ "properties" : {
+ "description" : {
+ "description" : "Your description for the split configuration.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "rules" : {
+ "description" : "Array of rules that define the split configuration behavior.",
+ "items" : {
+ "$ref" : "#/components/schemas/SplitConfigurationRule"
+ },
+ "type" : "array"
+ },
+ "splitConfigurationId" : {
+ "description" : "Unique identifier of the split configuration.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "stores" : {
+ "description" : "List of stores to which the split configuration applies.",
+ "items" : {
+ "type" : "string"
+ },
+ "readOnly" : true,
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "description",
+ "rules"
+ ],
+ "type" : "object"
+ },
+ "SplitConfigurationList" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of split configurations applied to the stores under the merchant account.",
+ "items" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "SplitConfigurationLogic" : {
+ "properties" : {
+ "acquiringFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "additionalCommission" : {
+ "description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
+ "$ref" : "#/components/schemas/AdditionalCommission"
+ },
+ "adyenCommission" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenMarkup" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "chargeback" : {
+ "description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount",
+ "deductAccordingToSplitRatio"
+ ],
+ "type" : "string"
+ },
+ "chargebackCostAllocation" : {
+ "description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "commission" : {
+ "description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
+ "$ref" : "#/components/schemas/Commission"
+ },
+ "interchange" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "paymentFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "remainder" : {
+ "description" : "Specifies the logic to apply when booking the amount left over after currency conversion.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "schemeFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "splitLogicId" : {
+ "description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "surcharge" : {
+ "description" : "Specifies the logic to apply when booking the surcharge amount.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "tip" : {
+ "description" : "Specifies the logic to apply when booking tips (gratuity).\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "commission"
+ ],
+ "type" : "object"
+ },
+ "SplitConfigurationRule" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
+ "type" : "string"
+ },
+ "fundingSource" : {
+ "description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.",
+ "enum" : [
+ "credit",
+ "debit",
+ "ANY"
+ ],
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method condition that defines whether the split logic applies.\n\nPossible values:\n* [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method.\n* **ANY**: Apply the split logic for all available payment methods.",
+ "type" : "string"
+ },
+ "ruleId" : {
+ "description" : "The unique identifier of the split configuration rule.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel condition that defines whether the split logic applies.\n\nPossible values:\n* **Ecommerce**: Online transactions where the cardholder is present.\n* **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).\n* **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.\n* **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.\n* **ANY**: All sales channels.",
+ "enum" : [
+ "Ecommerce",
+ "ContAuth",
+ "Moto",
+ "POS",
+ "ANY"
+ ],
+ "type" : "string"
+ },
+ "splitLogic" : {
+ "description" : "Contains the split logic that is applied if the rule conditions are met.",
+ "$ref" : "#/components/schemas/SplitConfigurationLogic"
+ }
+ },
+ "required" : [
+ "paymentMethod",
+ "shopperInteraction",
+ "currency",
+ "splitLogic"
+ ],
+ "type" : "object"
+ },
+ "Standalone" : {
+ "properties" : {
+ "currencyCode" : {
+ "description" : "The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "enableStandalone" : {
+ "description" : "Enable standalone mode.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Store" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Reference to resources connected with the store.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with.\n If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "The description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the store. This value is generated by Adyen.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account that the store belongs to.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "A reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name shown on the shopper's bank or credit card statement and on the shopper receipt.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platforms merchants to split the transaction amount and fees.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ },
+ "status" : {
+ "description" : "The status of the store. Possible values are:\n\n- **active**. This value is assigned automatically when a store is created. \n- **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.\n- **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.",
+ "enum" : [
+ "active",
+ "closed",
+ "inactive"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "StoreCreationRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.\nIf not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).\n\nIf you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.\nMaximum length: 22 characters; can't be all numbers.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platforms merchants to split the transaction amount and fees.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ }
+ },
+ "required" : [
+ "description",
+ "shopperStatement",
+ "phoneNumber",
+ "address"
+ ],
+ "type" : "object"
+ },
+ "StoreCreationWithMerchantCodeRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.\nIf not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account that the store belongs to.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).\n\nIf you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.\nMaximum length: 22 characters; can't be all numbers.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platforms merchants to split the transaction amount and fees.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ }
+ },
+ "required" : [
+ "description",
+ "shopperStatement",
+ "phoneNumber",
+ "address",
+ "merchantId"
+ ],
+ "type" : "object"
+ },
+ "StoreLocation" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "country" : {
+ "description" : "The two-letter country code in [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.",
+ "type" : "string"
+ },
+ "line1" : {
+ "description" : "The street address.",
+ "type" : "string"
+ },
+ "line2" : {
+ "description" : "Second address line.",
+ "type" : "string"
+ },
+ "line3" : {
+ "description" : "Third address line.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "country"
+ ],
+ "type" : "object"
+ },
+ "StoreSplitConfiguration" : {
+ "properties" : {
+ "balanceAccountId" : {
+ "description" : "The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) to which the split amount must be booked, depending on the defined [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/splitConfigurations#request-rules-splitLogic).",
+ "type" : "string"
+ },
+ "splitConfigurationId" : {
+ "description" : "The unique identifier of the [split configuration profile](https://docs.adyen.com/marketplaces-and-platforms/automatic-split-configuration/create-split-configuration/).",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Surcharge" : {
+ "properties" : {
+ "askConfirmation" : {
+ "description" : "Show the surcharge details on the terminal, so the shopper can confirm.",
+ "type" : "boolean"
+ },
+ "configurations" : {
+ "description" : "Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies.",
+ "items" : {
+ "$ref" : "#/components/schemas/Configuration"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "SwishInfo" : {
+ "properties" : {
+ "swishNumber" : {
+ "description" : "Swish number. Format: 10 digits without spaces. For example, **1231111111**.",
+ "maxLength" : 10,
+ "minLength" : 10,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "swishNumber"
+ ],
+ "type" : "object"
+ },
+ "TapToPay" : {
+ "properties" : {
+ "merchantDisplayName" : {
+ "description" : "The text shown on the screen during the Tap to Pay transaction.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Terminal" : {
+ "properties" : {
+ "assignment" : {
+ "x-addedInVersion" : "2",
+ "description" : "Indicates the account level to which the terminal is assigned, the [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api), and where the terminals is in the process of being reassigned to.",
+ "$ref" : "#/components/schemas/TerminalAssignment"
+ },
+ "connectivity" : {
+ "x-addedInVersion" : "2",
+ "description" : "Information about bluetooth, cellular, ethernet and wifi connectivity for the terminal.",
+ "$ref" : "#/components/schemas/TerminalConnectivity"
+ },
+ "firmwareVersion" : {
+ "description" : "The software release currently in use on the terminal.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the terminal.",
+ "type" : "string"
+ },
+ "lastActivityAt" : {
+ "x-addedInVersion" : "2",
+ "description" : "Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "lastTransactionAt" : {
+ "x-addedInVersion" : "2",
+ "description" : "Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "model" : {
+ "x-addedInVersion" : "2",
+ "description" : "The model name of the terminal.",
+ "type" : "string"
+ },
+ "serialNumber" : {
+ "description" : "The serial number of the terminal.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalActionScheduleDetail" : {
+ "properties" : {
+ "id" : {
+ "description" : "The ID of the action on the specified terminal.",
+ "type" : "string"
+ },
+ "terminalId" : {
+ "description" : "The unique ID of the terminal that the action applies to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalAssignment" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which terminal is assigned.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which terminal is assigned.",
+ "type" : "string"
+ },
+ "reassignmentTarget" : {
+ "description" : "Indicates where the terminal is in the process of being reassigned to.",
+ "$ref" : "#/components/schemas/TerminalReassignmentTarget"
+ },
+ "status" : {
+ "description" : "The status of the reassignment. Possible values: \n * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`: the terminal is deployed and reassigned. \n * `inventory`: the terminal is in inventory and cannot process transactions. \n * `boarded`: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions. \n",
+ "enum" : [
+ "boarded",
+ "deployed",
+ "inventory",
+ "reassignmentInProgress"
+ ],
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which terminal is assigned.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "companyId",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "TerminalConnectivity" : {
+ "properties" : {
+ "bluetooth" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityBluetooth"
+ },
+ "cellular" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityCellular"
+ },
+ "ethernet" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityEthernet"
+ },
+ "wifi" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityWifi"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityBluetooth" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's Bluetooth IP address.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's Bluetooth MAC address.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityCellular" : {
+ "properties" : {
+ "iccid" : {
+ "description" : "The integrated circuit card identifier (ICCID) of the SIM card in the terminal.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal.",
+ "enum" : [
+ "activated",
+ "deactivated",
+ "deprecated",
+ "inventory",
+ "readyForActivation"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityEthernet" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's ethernet IP address.",
+ "type" : "string"
+ },
+ "linkNegotiation" : {
+ "description" : "The ethernet link negotiation that the terminal uses.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's ethernet MAC address.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityWifi" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's IP address in the Wi-Fi network.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's MAC address in the Wi-Fi network.",
+ "type" : "string"
+ },
+ "ssid" : {
+ "description" : "The SSID of the Wi-Fi network that the terminal is connected to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalInstructions" : {
+ "properties" : {
+ "adyenAppRestart" : {
+ "description" : "Indicates whether the Adyen app on the payment terminal restarts automatically when the configuration is updated.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalModelsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The terminal models that the API credential has access to.",
+ "items" : {
+ "$ref" : "#/components/schemas/IdName"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrder" : {
+ "properties" : {
+ "billingEntity" : {
+ "description" : "The details of the entity that the order is billed to.",
+ "$ref" : "#/components/schemas/BillingEntity"
+ },
+ "customerOrderReference" : {
+ "description" : "The merchant-defined purchase order number. This will be printed on the packing list.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the order.",
+ "type" : "string"
+ },
+ "items" : {
+ "description" : "The products included in the order.",
+ "items" : {
+ "$ref" : "#/components/schemas/OrderItem"
+ },
+ "type" : "array"
+ },
+ "orderDate" : {
+ "description" : "The date and time that the order was placed, in UTC ISO 8601 format. For example, \"2011-12-03T10:15:30Z\".",
+ "type" : "string"
+ },
+ "shippingLocation" : {
+ "description" : "The details of the location where the order is shipped to.",
+ "$ref" : "#/components/schemas/ShippingLocation"
+ },
+ "status" : {
+ "description" : "The processing status of the order.",
+ "type" : "string"
+ },
+ "trackingUrl" : {
+ "description" : "The URL, provided by the carrier company, where the shipment can be tracked.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrderRequest" : {
+ "properties" : {
+ "billingEntityId" : {
+ "description" : "The identification of the billing entity to use for the order.",
+ "type" : "string"
+ },
+ "customerOrderReference" : {
+ "description" : "The merchant-defined purchase order reference.",
+ "type" : "string"
+ },
+ "items" : {
+ "description" : "The products included in the order.",
+ "items" : {
+ "$ref" : "#/components/schemas/OrderItem"
+ },
+ "type" : "array"
+ },
+ "orderType" : {
+ "description" : "Type of order",
+ "type" : "string"
+ },
+ "shippingLocationId" : {
+ "description" : "The identification of the shipping location to use for the order.",
+ "type" : "string"
+ },
+ "taxId" : {
+ "description" : "The tax number of the billing entity.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrdersResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of orders for payment terminal packages and parts.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProduct" : {
+ "properties" : {
+ "description" : {
+ "description" : "Information about items included and integration options.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the product.",
+ "type" : "string"
+ },
+ "itemsIncluded" : {
+ "description" : "A list of parts included in the terminal package.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "name" : {
+ "description" : "The descriptive name of the product.",
+ "type" : "string"
+ },
+ "price" : {
+ "description" : "The price of the product.",
+ "$ref" : "#/components/schemas/TerminalProductPrice"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProductPrice" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The price of the item.",
+ "format" : "double",
+ "type" : "number"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProductsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Terminal products that can be ordered.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalProduct"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalReassignmentRequest" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "inventory" : {
+ "description" : "Must be specified when reassigning terminals to a merchant account:\n\n- If set to **true**, reassigns terminals to the inventory of the merchant account and the terminals cannot process transactions.\n\n- If set to **false**, reassigns terminals directly to the merchant account and the terminals can process transactions.",
+ "type" : "boolean"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which the terminal is reassigned. When reassigning terminals to a merchant account, you must specify the `inventory` field.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which the terminal is reassigned.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalReassignmentTarget" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "inventory" : {
+ "description" : "Indicates if the terminal is reassigned to the inventory of the merchant account.\n- If **true**, the terminal is in the inventory of the merchant account and cannot process transactions.\n- If **false**, the terminal is reassigned directly to the merchant account and can process transactions.",
+ "type" : "boolean"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which the terminal is reassigned.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "inventory"
+ ],
+ "type" : "object"
+ },
+ "TerminalSettings" : {
+ "properties" : {
+ "cardholderReceipt" : {
+ "description" : "Settings to define the header of the shopper receipt.",
+ "$ref" : "#/components/schemas/CardholderReceipt"
+ },
+ "connectivity" : {
+ "description" : "Settings for terminal connectivity features.",
+ "$ref" : "#/components/schemas/Connectivity"
+ },
+ "gratuities" : {
+ "description" : "Settings for tipping with or without predefined options to choose from. The maximum number of predefined options is four, or three plus the option to enter a custom tip.",
+ "items" : {
+ "$ref" : "#/components/schemas/Gratuity"
+ },
+ "type" : "array"
+ },
+ "hardware" : {
+ "description" : "Settings for terminal hardware features.",
+ "$ref" : "#/components/schemas/Hardware"
+ },
+ "localization" : {
+ "description" : "Settings for localization.",
+ "$ref" : "#/components/schemas/Localization"
+ },
+ "nexo" : {
+ "description" : "Settings for a Terminal API integration.",
+ "$ref" : "#/components/schemas/Nexo"
+ },
+ "offlineProcessing" : {
+ "description" : "Settings for [offline payment](https://docs.adyen.com/point-of-sale/offline-payments) features.",
+ "$ref" : "#/components/schemas/OfflineProcessing"
+ },
+ "opi" : {
+ "description" : "Settings for an Oracle Payment Interface (OPI) integration.",
+ "$ref" : "#/components/schemas/Opi"
+ },
+ "passcodes" : {
+ "description" : "Settings for [passcodes](https://docs.adyen.com/point-of-sale/managing-terminals/menu-access?tab=manage_passcodes_with_an_api_call_2#manage-passcodes) features.",
+ "$ref" : "#/components/schemas/Passcodes"
+ },
+ "payAtTable" : {
+ "description" : "Settings for [Pay-at-table](https://docs.adyen.com/point-of-sale/pay-at-x) features.",
+ "$ref" : "#/components/schemas/PayAtTable"
+ },
+ "payment" : {
+ "description" : "Settings for payment features.",
+ "$ref" : "#/components/schemas/Payment"
+ },
+ "receiptOptions" : {
+ "description" : "Generic receipt settings.",
+ "$ref" : "#/components/schemas/ReceiptOptions"
+ },
+ "receiptPrinting" : {
+ "description" : "Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.",
+ "$ref" : "#/components/schemas/ReceiptPrinting"
+ },
+ "refunds" : {
+ "description" : "Settings for refunds.",
+ "$ref" : "#/components/schemas/Refunds"
+ },
+ "signature" : {
+ "description" : "Settings to skip signature, sign on display, or sign on receipt.",
+ "$ref" : "#/components/schemas/Signature"
+ },
+ "standalone" : {
+ "description" : "Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features.",
+ "$ref" : "#/components/schemas/Standalone"
+ },
+ "surcharge" : {
+ "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.",
+ "$ref" : "#/components/schemas/Surcharge"
+ },
+ "tapToPay" : {
+ "description" : "Settings for Tap to Pay.",
+ "$ref" : "#/components/schemas/TapToPay"
+ },
+ "terminalInstructions" : {
+ "description" : "Settings to define the behaviour of the payment terminal.",
+ "$ref" : "#/components/schemas/TerminalInstructions"
+ },
+ "timeouts" : {
+ "description" : "Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out).",
+ "$ref" : "#/components/schemas/Timeouts"
+ },
+ "wifiProfiles" : {
+ "description" : "Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.",
+ "$ref" : "#/components/schemas/WifiProfiles"
+ }
+ },
+ "type" : "object"
+ },
+ "TestCompanyWebhookRequest" : {
+ "properties" : {
+ "merchantIds" : {
+ "description" : "List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values.\n\nIf not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "notification" : {
+ "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.",
+ "$ref" : "#/components/schemas/CustomNotification"
+ },
+ "types" : {
+ "description" : "List of event codes for which to send test notifications. Only the webhook types below are supported. \n\nPossible values if webhook `type`: **standard**:\n\n* **AUTHORISATION**\n* **CHARGEBACK_REVERSED**\n* **ORDER_CLOSED**\n* **ORDER_OPENED**\n* **PAIDOUT_REVERSED**\n* **PAYOUT_THIRDPARTY**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**\n* **REPORT_AVAILABLE**\n* **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.\n\nPossible values if webhook `type`: **banktransfer-notification**:\n\n* **PENDING**\n\nPossible values if webhook `type`: **report-notification**:\n\n* **REPORT_AVAILABLE**\n\nPossible values if webhook `type`: **ideal-notification**:\n\n* **AUTHORISATION**\n\nPossible values if webhook `type`: **pending-notification**:\n\n* **PENDING**\n",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TestOutput" : {
+ "properties" : {
+ "merchantId" : {
+ "description" : "Unique identifier of the merchant account that the notification is about.",
+ "type" : "string"
+ },
+ "output" : {
+ "description" : "The response your server returned for the test webhook.\n\nYour server must respond with **[accepted]** for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
+ "type" : "string"
+ },
+ "requestSent" : {
+ "description" : "The [body of the notification webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#notification-structure) that was sent to your server.",
+ "type" : "string"
+ },
+ "responseCode" : {
+ "description" : "The HTTP response code for your server's response to the test webhook.\n\nYou can use the value of this field together with the the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field value to troubleshoot failed test webhooks.",
+ "example" : "200",
+ "type" : "string"
+ },
+ "responseTime" : {
+ "description" : "The time between sending the test webhook and receiving the response from your server. You can use it as an indication of how long your server takes to process a webhook notification. Measured in milliseconds, for example **304 ms**.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the test request. Possible values are:\n* **success**, if `data.output`: **[accepted]** and `data.responseCode`: **200**.\n* **failed**, in all other cases.\n\nYou can use the value of the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot failed test webhooks.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "status"
+ ],
+ "type" : "object"
+ },
+ "TestWebhookRequest" : {
+ "properties" : {
+ "notification" : {
+ "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.",
+ "$ref" : "#/components/schemas/CustomNotification"
+ },
+ "types" : {
+ "description" : "List of event codes for which to send test notifications. Only the webhook types below are supported. \n\nPossible values if webhook `type`: **standard**:\n\n* **AUTHORISATION**\n* **CHARGEBACK_REVERSED**\n* **ORDER_CLOSED**\n* **ORDER_OPENED**\n* **PAIDOUT_REVERSED**\n* **PAYOUT_THIRDPARTY**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**\n* **REPORT_AVAILABLE**\n* **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.\n\nPossible values if webhook `type`: **banktransfer-notification**:\n\n* **PENDING**\n\nPossible values if webhook `type`: **report-notification**:\n\n* **REPORT_AVAILABLE**\n\nPossible values if webhook `type`: **ideal-notification**:\n\n* **AUTHORISATION**\n\nPossible values if webhook `type`: **pending-notification**:\n\n* **PENDING**\n",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TestWebhookResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List with test results. Each test webhook we send has a list element with the result.",
+ "items" : {
+ "$ref" : "#/components/schemas/TestOutput"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Timeouts" : {
+ "properties" : {
+ "fromActiveToSleep" : {
+ "description" : "Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "TransactionDescriptionInfo" : {
+ "properties" : {
+ "doingBusinessAsName" : {
+ "description" : "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.",
+ "maxLength" : 22,
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "dynamic",
+ "description" : "The type of transaction description you want to use:\n- **fixed**: The transaction description set in this request is used for all payments with this payment method.\n- **append**: The transaction description set in this request is used as a base for all payments with this payment method. The [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.\n- **dynamic**: Only the [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method.",
+ "enum" : [
+ "append",
+ "dynamic",
+ "fixed"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TwintInfo" : {
+ "properties" : {
+ "logo" : {
+ "description" : "Twint logo. Format: Base64-encoded string.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo"
+ ],
+ "type" : "object"
+ },
+ "UninstallAndroidAppDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "appId" : {
+ "description" : "The unique identifier of the app to be uninstalled.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "UninstallAndroidApp",
+ "description" : "Type of terminal action: Uninstall an Android app.",
+ "enum" : [
+ "UninstallAndroidApp"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UninstallAndroidCertificateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "certificateId" : {
+ "description" : "The unique identifier of the certificate to be uninstalled.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "UninstallAndroidCertificate",
+ "description" : "Type of terminal action: Uninstall an Android certificate.",
+ "enum" : [
+ "UninstallAndroidCertificate"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatableAddress" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "line1" : {
+ "description" : "The street address.",
+ "type" : "string"
+ },
+ "line2" : {
+ "description" : "Second address line.",
+ "type" : "string"
+ },
+ "line3" : {
+ "description" : "Third address line.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyApiCredentialRequest" : {
+ "properties" : {
+ "active" : {
+ "description" : "Indicates if the API credential is enabled.",
+ "type" : "boolean"
+ },
+ "allowedOrigins" : {
+ "description" : "The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) to associate the user with.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name2"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are filtered when configuring the webhook. Possible values:\n* **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantApiCredentialRequest" : {
+ "properties" : {
+ "active" : {
+ "description" : "Indicates if the API credential is enabled.",
+ "type" : "boolean"
+ },
+ "allowedOrigins" : {
+ "description" : "The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Sets the status of the user to active (**true**) or inactive (**false**).",
+ "type" : "boolean"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name2"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatePaymentMethodInfo" : {
+ "properties" : {
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "customRoutingFlags" : {
+ "description" : "Custom routing flags for acquirer routing.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "enabled" : {
+ "description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
+ "type" : "boolean"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "storeIds" : {
+ "description" : "The list of stores for this payment method",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatePayoutSettingsRequest" : {
+ "properties" : {
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationLogicRequest" : {
+ "properties" : {
+ "acquiringFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "additionalCommission" : {
+ "description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
+ "$ref" : "#/components/schemas/AdditionalCommission"
+ },
+ "adyenCommission" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenMarkup" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "chargeback" : {
+ "description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount",
+ "deductAccordingToSplitRatio"
+ ],
+ "type" : "string"
+ },
+ "chargebackCostAllocation" : {
+ "description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "commission" : {
+ "description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
+ "$ref" : "#/components/schemas/Commission"
+ },
+ "interchange" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "paymentFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "remainder" : {
+ "description" : "Specifies the logic to apply when booking the amount left over after currency conversion.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "schemeFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "splitLogicId" : {
+ "description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "surcharge" : {
+ "description" : "Specifies the logic to apply when booking the surcharge amount.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "tip" : {
+ "description" : "Specifies the logic to apply when booking tips (gratuity).\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "commission"
+ ],
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationRequest" : {
+ "properties" : {
+ "description" : {
+ "description" : "Your description for the split configuration.",
+ "maxLength" : 300,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "description"
+ ],
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationRuleRequest" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
+ "type" : "string"
+ },
+ "fundingSource" : {
+ "description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.",
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method condition that defines whether the split logic applies.\n\nPossible values:\n* [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method.\n* **ANY**: Apply the split logic for all available payment methods.",
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel condition that defines whether the split logic applies.\n\nPossible values:\n* **Ecommerce**: Online transactions where the cardholder is present.\n* **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).\n* **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.\n* **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.\n* **ANY**: All sales channels.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "paymentMethod",
+ "shopperInteraction",
+ "currency"
+ ],
+ "type" : "object"
+ },
+ "UpdateStoreRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store. It is not possible to update the country of the store.",
+ "$ref" : "#/components/schemas/UpdatableAddress"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "The description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platforms merchants to split the transaction amount and fees.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ },
+ "status" : {
+ "description" : "The status of the store. Possible values are:\n\n- **active**: This value is assigned automatically when a store is created. \n- **inactive**: The maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible.\n- **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.\n\nYou can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**. \nOnce **closed**, a store can't be reopened.",
+ "enum" : [
+ "active",
+ "closed",
+ "inactive"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UploadAndroidAppResponse" : {
+ "properties" : {
+ "id" : {
+ "description" : "The unique identifier of the uploaded Android app.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Url" : {
+ "properties" : {
+ "encrypted" : {
+ "description" : "Indicates if the message sent to this URL should be encrypted.",
+ "type" : "boolean"
+ },
+ "password" : {
+ "description" : "The password for authentication of the notifications.",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "The URL in the format: http(s)://domain.com.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for authentication of the notifications.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "User" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "VippsInfo" : {
+ "properties" : {
+ "logo" : {
+ "description" : "Vipps logo. Format: Base64-encoded string.",
+ "type" : "string"
+ },
+ "subscriptionCancelUrl" : {
+ "description" : "Vipps subscription cancel url (required in case of [recurring payments](https://docs.adyen.com/online-payments/tokenization))",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo"
+ ],
+ "type" : "object"
+ },
+ "Webhook" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this webhook.",
+ "$ref" : "#/components/schemas/WebhookLinks"
+ },
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "accountReference" : {
+ "description" : "Reference to the account the webook is set on.",
+ "type" : "string"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for you to receive webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettingsResponse"
+ },
+ "certificateAlias" : {
+ "description" : "The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.",
+ "type" : "string"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are included in company-level webhooks. Possible values:\n* **includeAccounts**\n* **excludeAccounts**\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "hasError" : {
+ "description" : "Indicates if the webhook configuration has errors that need troubleshooting. If the value is **true**, troubleshoot the configuration using the [testing endpoint](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookid}/test).",
+ "type" : "boolean"
+ },
+ "hasPassword" : {
+ "description" : "Indicates if the webhook is password protected.",
+ "type" : "boolean"
+ },
+ "hmacKeyCheckValue" : {
+ "description" : "The [checksum](https://en.wikipedia.org/wiki/Key_checksum_value) of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier for this webhook.",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API details webhooks.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "type",
+ "url",
+ "active",
+ "communicationFormat"
+ ],
+ "type" : "object"
+ },
+ "WebhookLinks" : {
+ "properties" : {
+ "company" : {
+ "description" : "The company account that the webhook is configured for. Only present for company-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateHmac" : {
+ "description" : "Generate an HMAC key.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "merchant" : {
+ "description" : "The merchant account that the webhook is configured for. Only present for merchant-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "testWebhook" : {
+ "description" : "Test the webhook setup.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self",
+ "testWebhook",
+ "generateHmac"
+ ],
+ "type" : "object"
+ },
+ "WifiProfiles" : {
+ "properties" : {
+ "profiles" : {
+ "description" : "List of remote Wi-Fi profiles.",
+ "items" : {
+ "$ref" : "#/components/schemas/Profile"
+ },
+ "type" : "array"
+ },
+ "settings" : {
+ "description" : "General Wi-Fi settings.",
+ "$ref" : "#/components/schemas/Settings"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "securitySchemes" : {
+ "ApiKeyAuth" : {
+ "in" : "header",
+ "name" : "X-API-Key",
+ "type" : "apiKey"
+ },
+ "BasicAuth" : {
+ "scheme" : "basic",
+ "type" : "http"
+ }
+ },
+ "examples" : {
+ "get-companies-companyId-androidApps-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of Android apps",
+ "value" : {
+ "data" : [
+ {
+ "id" : "ANDA422LZ223223K5F694GCCF732K8",
+ "packageName" : "com.your_company.posapp",
+ "versionCode" : 7700203,
+ "description" : "POS2",
+ "label" : "POS system",
+ "versionName" : "7.7",
+ "status" : "ready"
+ },
+ {
+ "id" : "ANDA422LZ223223K5F694FWCF738PL",
+ "packageName" : "com.your_company.posapp",
+ "versionCode" : 7602003,
+ "description" : "POS1",
+ "label" : "POS system",
+ "versionName" : "7.6",
+ "status" : "ready"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-androidCertificates-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of Android certificates",
+ "value" : {
+ "data" : [
+ {
+ "id" : "ANDC422LZ223223K5F78NVN9SL4VPH",
+ "name" : "mycert",
+ "extension" : ".crt",
+ "description" : "",
+ "status" : "ready",
+ "notBefore" : "2008-04-20T00:00:00+02:00",
+ "notAfter" : "2038-04-12T00:00:00+02:00"
+ },
+ {
+ "id" : "ANDC533MA33433L689OWO0TM5WQI",
+ "name" : "mynewcert",
+ "extension" : ".pem",
+ "description" : "",
+ "status" : "ready",
+ "notBefore" : "2008-04-20T00:00:00+02:00",
+ "notAfter" : "2048-04-12T00:00:00+02:00"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200" : {
+ "summary" : "OK 200 - Get the list of allowed origins for the API credential",
+ "description" : "Example response for getting the list of allowed origins for the API credential.",
+ "value" : {
+ "data" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origin-200" : {
+ "summary" : "OK 200 - Get an allowed origin for the API credential",
+ "description" : "Example response for getting an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-success-200" : {
+ "summary" : "Details of the API credential",
+ "description" : "Example response with details of the API credential at the company level",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "http://localhost",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "http://localhost:3000",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-success-200" : {
+ "summary" : "List of API credentials",
+ "description" : "Example response when your API credential has access to 25 API credentials at the company level",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 25,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_API_CREDENTIAL_1",
+ "username" : "YOUR_USERNAME_1",
+ "clientKey" : "YOUR_CLIENT_KEY_1",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "http://localhost",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "http://localhost:3000",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_2",
+ "username" : "YOUR_USERNAME_2",
+ "clientKey" : "YOUR_CLIENT_KEY_2",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_3",
+ "username" : "YOUR_USERNAME_3",
+ "clientKey" : "YOUR_CLIENT_KEY_3",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "API Supply MPI data with Payments",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "API 3DS 2.0 to retrieve the ThreeDS2Result for authentication only"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_4",
+ "username" : "YOUR_USERNAME_4",
+ "clientKey" : "YOUR_CLIENT_KEY_4",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_1"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_5",
+ "username" : "YOUR_USERNAME_5",
+ "clientKey" : "YOUR_CLIENT_KEY_5",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API Authorise Referred Payments",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_6",
+ "username" : "YOUR_USERNAME_6",
+ "clientKey" : "YOUR_CLIENT_KEY_6",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_7",
+ "username" : "YOUR_USERNAME_7",
+ "clientKey" : "YOUR_CLIENT_KEY_7",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_2",
+ "YOUR_MERCHANT_ACCOUNT_3"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_8",
+ "username" : "YOUR_USERNAME_8",
+ "clientKey" : "YOUR_CLIENT_KEY_8",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_9",
+ "username" : "YOUR_USERNAME_9",
+ "clientKey" : "YOUR_CLIENT_KEY_9",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_4",
+ "YOUR_MERCHANT_ACCOUNT_5"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_10",
+ "username" : "YOUR_USERNAME_10",
+ "clientKey" : "YOUR_CLIENT_KEY_10",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-billingEntities-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with billing entities for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-merchants-success-200" : {
+ "summary" : "List of merchant accounts",
+ "description" : "Example response when your API credential has access to 22 merchant accounts",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 22,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_1",
+ "name" : "YOUR_MERCHANT_NAME_1",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_1",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_2",
+ "name" : "YOUR_MERCHANT_NAME_2",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "POS",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_2",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_3",
+ "status" : "Active",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_4",
+ "name" : "YOUR_MERCHANT_NAME_4",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_4",
+ "merchantCity" : "Sao Paulo",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_5",
+ "name" : "YOUR_MERCHANT_NAME_5",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_5",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_6",
+ "name" : "YOUR_MERCHANT_NAME_6",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_6",
+ "merchantCity" : "Zagreb",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_7",
+ "name" : "YOUR_MERCHANT_NAME_7",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Moto",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_7",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_8",
+ "name" : "YOUR_MERCHANT_NAME_8",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_8",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_9",
+ "name" : "YOUR_MERCHANT_NAME_9",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_9",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_10",
+ "name" : "YOUR_MERCHANT_NAME_10",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_10",
+ "merchantCity" : "Paris",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-shippingLocations-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with shipping locations for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-success-200" : {
+ "summary" : "Details of the company account",
+ "description" : "Example response with the details of the company account.",
+ "value" : {
+ "id" : "YOUR_COMPANY_ACCOUNT",
+ "name" : "YOUR_SHOP_NAME",
+ "status" : "Active",
+ "dataCenters" : [
+ {
+ "name" : "default",
+ "livePrefix" : ""
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"
+ }
+ }
+ }
+ },
+ "get-companies-companyId-terminalActions-actionId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the specified terminal action",
+ "value" : {
+ "actionType" : "InstallAndroidCertificate",
+ "config" : "{\"certificates\":\"5dff6b...\"}",
+ "confirmedAt" : "2022-06-27T17:44:54+02:00",
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "result" : "Ok",
+ "scheduledAt" : "2022-06-27T15:44:07+02:00",
+ "status" : "successful",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ },
+ "get-companies-companyId-terminalActions-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of scheduled terminal actions",
+ "value" : {
+ "data" : [
+ {
+ "actionType" : "InstallAndroidApp",
+ "config" : "{\"apps\":\"com.adyen.android.calculator:103\"}",
+ "confirmedAt" : "2021-11-10T00:00:00+01:00",
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "result" : "Cancelled manually by user USER@Psp.AdyenPspService",
+ "scheduledAt" : "2021-11-10T14:53:05+01:00",
+ "status" : "cancelled",
+ "terminalId" : "S1E-000150183300032"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-companies-companyId-terminalModels-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal models that the company has access to",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Verifone.e315",
+ "name" : "Verifone e315"
+ },
+ {
+ "id" : "Verifone.e315M",
+ "name" : "Verifone e315M"
+ },
+ {
+ "id" : "Verifone.E355",
+ "name" : "Verifone E355"
+ },
+ {
+ "id" : "Verifone.M400",
+ "name" : "Verifone M400"
+ },
+ {
+ "id" : "Verifone.MX915",
+ "name" : "Verifone MX915"
+ },
+ {
+ "id" : "Verifone.MX925",
+ "name" : "Verifone MX925"
+ },
+ {
+ "id" : "Verifone.P400",
+ "name" : "Verifone P400"
+ },
+ {
+ "id" : "Verifone.P400Plus",
+ "name" : "Verifone P400Plus"
+ },
+ {
+ "id" : "Verifone.P400Eth",
+ "name" : "Verifone P400Eth"
+ },
+ {
+ "id" : "Verifone.V240m",
+ "name" : "Verifone V240m"
+ },
+ {
+ "id" : "Verifone.V240mPlus",
+ "name" : "Verifone V240mPlus"
+ },
+ {
+ "id" : "Verifone.UX300",
+ "name" : "Verifone UX300"
+ },
+ {
+ "id" : "Verifone.V200cPlus",
+ "name" : "Verifone V200cPlus"
+ },
+ {
+ "id" : "Verifone.V400cPlus",
+ "name" : "Verifone V400cPlus"
+ },
+ {
+ "id" : "Verifone.V400m",
+ "name" : "Verifone V400m"
+ },
+ {
+ "id" : "Verifone.V210mPlus",
+ "name" : "Verifone V210mPlus"
+ },
+ {
+ "id" : "Verifone.VX520",
+ "name" : "Verifone VX520"
+ },
+ {
+ "id" : "Verifone.VX6753G",
+ "name" : "Verifone VX6753G"
+ },
+ {
+ "id" : "Verifone.VX675WIFIBT",
+ "name" : "Verifone VX675WIFIBT"
+ },
+ {
+ "id" : "Verifone.VX680",
+ "name" : "Verifone VX680"
+ },
+ {
+ "id" : "Verifone.VX6803G",
+ "name" : "Verifone VX6803G"
+ },
+ {
+ "id" : "Verifone.VX690",
+ "name" : "Verifone VX690"
+ },
+ {
+ "id" : "Verifone.VX700",
+ "name" : "Verifone VX700"
+ },
+ {
+ "id" : "Verifone.VX810",
+ "name" : "Verifone VX810"
+ },
+ {
+ "id" : "Verifone.VX820",
+ "name" : "Verifone VX820"
+ },
+ {
+ "id" : "Verifone.VX825",
+ "name" : "Verifone VX825"
+ },
+ {
+ "id" : "Verifone.e285",
+ "name" : "Verifone e285"
+ },
+ {
+ "id" : "Verifone.E285",
+ "name" : "Verifone E285"
+ },
+ {
+ "id" : "Verifone.e285p",
+ "name" : "Verifone e285p"
+ },
+ {
+ "id" : "Verifone.e280",
+ "name" : "Verifone e280"
+ },
+ {
+ "id" : "Verifone.UX410",
+ "name" : "Verifone UX410"
+ },
+ {
+ "id" : "Castles.S1E",
+ "name" : "Castles S1E"
+ },
+ {
+ "id" : "Castles.S1EL",
+ "name" : "Castles S1EL"
+ },
+ {
+ "id" : "Castles.S1F",
+ "name" : "Castles S1F"
+ },
+ {
+ "id" : "Castles.S1F2",
+ "name" : "Castles S1F2"
+ },
+ {
+ "id" : "Castles.S1F2L",
+ "name" : "Castles S1F2L"
+ },
+ {
+ "id" : "Castles.S1E2",
+ "name" : "Castles S1E2"
+ },
+ {
+ "id" : "Castles.S1E2L",
+ "name" : "Castles S1E2L"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalOrders-orderId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the terminal products order",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_1",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalOrders-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal orders for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_C2",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2020-06-10T17:03:11.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-MX925-422-EU",
+ "name" : "MX925 Package",
+ "quantity" : 1
+ }
+ ]
+ },
+ {
+ "id" : "9415936144678634",
+ "customerOrderReference" : "YOUR_REFERENCE_C1",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-03T16:41:07.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-774-EU",
+ "name" : "V400m Package",
+ "quantity" : 5
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalProducts-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with V400m products available in The Netherlands",
+ "value" : {
+ "data" : [
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-327486-EU",
+ "name" : "Battery - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-745984-EU",
+ "name" : "Power Supply EU - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "description" : "Includes an EU Power Supply, SIM Card and battery",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ },
+ "itemsIncluded" : [
+ "Receipt Roll",
+ "Terminal Device V400m EU/GB"
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-companies-companyId-webhooks-get-company-webhooks-200" : {
+ "summary" : "OK 200 - Get the list of webhook configurations",
+ "description" : "Example response for getting the list of webhook configurations.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "adyen",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-webhooks-webhookId-get-company-webhook-200" : {
+ "summary" : "OK 200 - Get a webhook configuration",
+ "description" : "Example response for getting a webhook configuration.",
+ "value" : {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "adyen",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ },
+ "get-companies-success-200" : {
+ "summary" : "List of company accounts",
+ "description" : "Example response when your API credential has access to one company account.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "YOUR_COMPANY_ACCOUNT",
+ "name" : "YOUR_COMPANY_NAME",
+ "status" : "Active",
+ "dataCenters" : [
+ {
+ "name" : "default",
+ "livePrefix" : ""
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origin-200" : {
+ "summary" : "OK 200 - Get the list of allowed origins for the API credential",
+ "description" : "Example response for getting the list of allowed origins for the API credential.",
+ "value" : {
+ "data" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origins-200" : {
+ "summary" : "OK 200 - Get an allowed origin for the API credential",
+ "description" : "Example response for getting an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-success-200" : {
+ "summary" : "Details of the API credential",
+ "description" : "Example response with details of the API credential at the merchant level",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-success-200" : {
+ "summary" : "List of API credentials at the merchant level",
+ "description" : "Example response when your API credential has access to 11 API credentials at the merchant level",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 11,
+ "pagesTotal" : 2,
+ "data" : [
+ {
+ "id" : "YOUR_API_CREDENTIAL_1",
+ "username" : "YOUR_USERNAME_1",
+ "clientKey" : "YOUR_CLIENT_KEY_1",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_2",
+ "username" : "YOUR_USERNAME_2",
+ "clientKey" : "YOUR_CLIENT_KEY_2",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Rss feed role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_3",
+ "username" : "YOUR_USERNAME_3",
+ "clientKey" : "YOUR_CLIENT_KEY_3",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant iDeal-API Webservice role",
+ "Management API - Accounts read",
+ "Management API - API credentials read and write",
+ "Management API — Payment methods read",
+ "Merchant PAL Donation role",
+ "Merchant PAL Charity role",
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role",
+ "Store payout detail and submit payout - withdrawal",
+ "Management API - Accounts read and write",
+ "Management API - Webhooks read",
+ "Merchant Payout role",
+ "API tokenise payment details",
+ "General API Payments role",
+ "API Supply MPI data with Payments",
+ "API Authorise Referred Payments",
+ "API PCI Payments role",
+ "CSC Tokenization Webservice role",
+ "Management API - Stores read",
+ "API Payment RefundWithData",
+ "API Clientside Encryption Payments role",
+ "API to retrieve authentication data",
+ "Management API - Stores read and write",
+ "Management API - Webhooks read and write",
+ "Mastercard inControl service",
+ "Merchant Recurring role",
+ "Management API - Payout Account Settings Read",
+ "API surcharge cost estimation and regulatory information",
+ "Store payout detail",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "YOUR_DOMAIN_1",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "YOUR_DOMAIN_2",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_4",
+ "username" : "YOUR_USERNAME_4",
+ "clientKey" : "YOUR_CLIENT_KEY_4",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "API Clientside Encryption Payments role",
+ "API tokenise payment details",
+ "General API Payments role",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "CSC Tokenization Webservice role",
+ "Checkout webservice role",
+ "ThreeDSecure WebService Role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_5",
+ "username" : "YOUR_USERNAME_5",
+ "clientKey" : "YOUR_CLIENT_KEY_5",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant iDeal-API Webservice role",
+ "General API Payments role",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_6",
+ "username" : "YOUR_USERNAME_6",
+ "clientKey" : "YOUR_CLIENT_KEY_6",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_7",
+ "username" : "YOUR_USERNAME_7",
+ "clientKey" : "YOUR_CLIENT_KEY_7",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_8",
+ "username" : "YOUR_USERNAME_8",
+ "clientKey" : "YOUR_CLIENT_KEY_8",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_9",
+ "username" : "YOUR_USERNAME_9",
+ "clientKey" : "YOUR_CLIENT_KEY_9",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_10",
+ "username" : "YOUR_USERNAME_10",
+ "clientKey" : "YOUR_CLIENT_KEY_10",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-billingEntities-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with billing entities for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-shippingLocations-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with shipping locations for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-splitConfigurations-splitConfigurationId-success-200" : {
+ "summary" : "Details of the split configuration",
+ "description" : "Example response with details of the split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "get-merchants-merchantId-splitConfigurations-success-200" : {
+ "summary" : "List of split configurations",
+ "description" : "Example response when retrieving the list of split configurations in your merchant account",
+ "value" : {
+ "data" : [
+ {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "GBP",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HP89PPCST6BCZ",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 200,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HP89PPCSV27VP",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HP89PPCSS24MF"
+ },
+ {
+ "description" : "Your description for the second split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-stores-reference-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-merchants-merchantId-stores-reference-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "receiptOptions" : {
+
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-merchants-merchantId-stores-storeId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the details of a store",
+ "value" : {
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-stores-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of stores for a merchant account",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ }
+ },
+ "itemsTotal" : 2,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ },
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL6",
+ "address" : {
+ "city" : "North Madison",
+ "country" : "US",
+ "line1" : "1492 Townline Road",
+ "line2" : "Rowland Business Park",
+ "postalCode" : "20577",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "West location",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1211992213193020",
+ "reference" : "Second Madison store",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-success-200" : {
+ "summary" : "Details of the merchant account",
+ "description" : "Example response with details of the merchant account",
+ "value" : {
+ "id" : "YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_NAME",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-merchants-merchantId-terminalModels-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal models that the merchant account has access to",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Verifone.e315",
+ "name" : "Verifone e315"
+ },
+ {
+ "id" : "Verifone.e315M",
+ "name" : "Verifone e315M"
+ },
+ {
+ "id" : "Verifone.E355",
+ "name" : "Verifone E355"
+ },
+ {
+ "id" : "Verifone.M400",
+ "name" : "Verifone M400"
+ },
+ {
+ "id" : "Verifone.MX915",
+ "name" : "Verifone MX915"
+ },
+ {
+ "id" : "Verifone.MX925",
+ "name" : "Verifone MX925"
+ },
+ {
+ "id" : "Verifone.P400",
+ "name" : "Verifone P400"
+ },
+ {
+ "id" : "Verifone.P400Plus",
+ "name" : "Verifone P400Plus"
+ },
+ {
+ "id" : "Verifone.P400Eth",
+ "name" : "Verifone P400Eth"
+ },
+ {
+ "id" : "Verifone.V240m",
+ "name" : "Verifone V240m"
+ },
+ {
+ "id" : "Verifone.V240mPlus",
+ "name" : "Verifone V240mPlus"
+ },
+ {
+ "id" : "Verifone.UX300",
+ "name" : "Verifone UX300"
+ },
+ {
+ "id" : "Verifone.V200cPlus",
+ "name" : "Verifone V200cPlus"
+ },
+ {
+ "id" : "Verifone.V400cPlus",
+ "name" : "Verifone V400cPlus"
+ },
+ {
+ "id" : "Verifone.V400m",
+ "name" : "Verifone V400m"
+ },
+ {
+ "id" : "Verifone.V210mPlus",
+ "name" : "Verifone V210mPlus"
+ },
+ {
+ "id" : "Verifone.VX520",
+ "name" : "Verifone VX520"
+ },
+ {
+ "id" : "Verifone.VX6753G",
+ "name" : "Verifone VX6753G"
+ },
+ {
+ "id" : "Verifone.VX675WIFIBT",
+ "name" : "Verifone VX675WIFIBT"
+ },
+ {
+ "id" : "Verifone.VX680",
+ "name" : "Verifone VX680"
+ },
+ {
+ "id" : "Verifone.VX6803G",
+ "name" : "Verifone VX6803G"
+ },
+ {
+ "id" : "Verifone.VX690",
+ "name" : "Verifone VX690"
+ },
+ {
+ "id" : "Verifone.VX700",
+ "name" : "Verifone VX700"
+ },
+ {
+ "id" : "Verifone.VX810",
+ "name" : "Verifone VX810"
+ },
+ {
+ "id" : "Verifone.VX820",
+ "name" : "Verifone VX820"
+ },
+ {
+ "id" : "Verifone.VX825",
+ "name" : "Verifone VX825"
+ },
+ {
+ "id" : "Verifone.e285",
+ "name" : "Verifone e285"
+ },
+ {
+ "id" : "Verifone.E285",
+ "name" : "Verifone E285"
+ },
+ {
+ "id" : "Verifone.e285p",
+ "name" : "Verifone e285p"
+ },
+ {
+ "id" : "Verifone.e280",
+ "name" : "Verifone e280"
+ },
+ {
+ "id" : "Verifone.UX410",
+ "name" : "Verifone UX410"
+ },
+ {
+ "id" : "Castles.S1E",
+ "name" : "Castles S1E"
+ },
+ {
+ "id" : "Castles.S1EL",
+ "name" : "Castles S1EL"
+ },
+ {
+ "id" : "Castles.S1F",
+ "name" : "Castles S1F"
+ },
+ {
+ "id" : "Castles.S1F2",
+ "name" : "Castles S1F2"
+ },
+ {
+ "id" : "Castles.S1F2L",
+ "name" : "Castles S1F2L"
+ },
+ {
+ "id" : "Castles.S1E2",
+ "name" : "Castles S1E2"
+ },
+ {
+ "id" : "Castles.S1E2L",
+ "name" : "Castles S1E2L"
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalOrders-orderId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the terminal products order",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalOrders-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal orders for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE_M2",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ },
+ {
+ "id" : "8315943674501996",
+ "customerOrderReference" : "YOUR_REFERENCE_M1",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-04T09:41:07.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-774-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalProducts-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with V400m products available in Spain",
+ "value" : {
+ "data" : [
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-327486-EU",
+ "name" : "Battery - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-745984-EU",
+ "name" : "Power Supply EU - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "description" : "Includes an EU Power Supply, SIM Card and battery",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ },
+ "itemsIncluded" : [
+ "Receipt Roll",
+ "Terminal Device V400m EU/GB"
+ ]
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-merchants-merchantId-webhooks-get-merchant-webhooks-200" : {
+ "summary" : "OK 200 - Get the list of webhook configurations",
+ "description" : "Example response for getting the list of webhook configurations.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-webhooks-webhookId-get-merchant-webhook-200" : {
+ "summary" : "OK 200 - Get a webhook configuration",
+ "description" : "Example response for getting a webhook configuration.",
+ "value" : {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ },
+ "get-merchants-success-200" : {
+ "summary" : "List of merchant accounts",
+ "description" : "Example response when your API credential has access to 23 merchant accounts",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 23,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_1",
+ "name" : "YOUR_MERCHANT_NAME_1",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_1",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_2",
+ "name" : "YOUR_MERCHANT_NAME_2",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "POS",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_2",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_3",
+ "status" : "YOUR_MERCHANT_NAME_3",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_4",
+ "name" : "YOUR_MERCHANT_NAME_4",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_4",
+ "merchantCity" : "Sao Paulo",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_5",
+ "name" : "YOUR_MERCHANT_NAME_5",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_5",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_6",
+ "name" : "YOUR_MERCHANT_NAME_6",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_6",
+ "merchantCity" : "Zagreb",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_7",
+ "name" : "YOUR_MERCHANT_NAME_7",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Moto",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_7",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_8",
+ "name" : "YOUR_MERCHANT_NAME_8",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_8",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_9",
+ "name" : "YOUR_MERCHANT_NAME_9",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_9",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_10",
+ "name" : "YOUR_MERCHANT_NAME_10",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_10",
+ "merchantCity" : "Paris",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-stores-storeId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the details of a store",
+ "value" : {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ }
+ },
+ "get-stores-storeId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-stores-storeId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-stores-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of stores",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ }
+ },
+ "itemsTotal" : 2,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ },
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL6",
+ "address" : {
+ "city" : "North Madison",
+ "country" : "US",
+ "line1" : "1492 Townline Road",
+ "line2" : "Rowland Business Park",
+ "postalCode" : "20577",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "West location",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1211992213193020",
+ "reference" : "Second Madison store",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-terminals-success-200" : {
+ "summary" : "List of terminals",
+ "description" : "Example response when getting terminals that your API credential has access to.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=0&pageSize=20"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "AMS1-000150183300032",
+ "model" : "AMS1",
+ "serialNumber" : "000150183300032",
+ "firmwareVersion" : "Castles_Android 1.89.4",
+ "assignment" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT",
+ "storeId" : "YOUR_STORE_ID",
+ "status" : "reassignmentInProgress",
+ "reassignmentTarget" : {
+ "inventory" : true
+ }
+ },
+ "connectivity" : {
+ "cellular" : {
+ "iccid" : "6006491286999921374"
+ },
+ "wifi" : {
+ "ipAddress" : "198.51.100.1",
+ "macAddress" : "C4:6E:33:26:36:E4"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-terminals-terminalId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-terminals-terminalId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential" : {
+ "summary" : "Activate an API credential",
+ "description" : "Example request for activating an API credential.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential-200" : {
+ "summary" : "OK 200 - Activate an API credential",
+ "description" : "Example response for activating an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Management API - Accounts read",
+ "Management API - Webhooks read",
+ "Management API - API credentials read and write",
+ "Management API - Stores read",
+ "Management API — Payment methods read",
+ "Management API - Stores read and write",
+ "Management API - Webhooks read and write",
+ "Merchant Recurring role",
+ "Data Protection API",
+ "Management API - Payout Account Settings Read",
+ "Checkout webservice role",
+ "Management API - Accounts read and write",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-companies-companyId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-companies-companyId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-companies-companyId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-companies-companyId-terminalOrders-orderId-update-order" : {
+ "summary" : "Update a terminal order",
+ "description" : "Example request to update an order for terminal products",
+ "value" : {
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 5
+ }
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalOrders-orderId-update-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_1",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-7973536B20662642215526704F302044452F714622375D476169",
+ "name" : "YOUR_COMPANY Rokin depot",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : "",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 5
+ }
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-companies-companyId-webhooks-webhookId-patch-company-webhook" : {
+ "summary" : "Activate the webhook",
+ "description" : "Example request for activating a webhook configuration.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-companies-companyId-webhooks-webhookId-patch-company-webhook-200" : {
+ "summary" : "OK 200 - Activate the webhook",
+ "description" : "Example response for activating a webhook configuration.",
+ "value" : {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential" : {
+ "summary" : "Activate an API credential",
+ "description" : "Example request for activating an API credential.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential-200" : {
+ "summary" : "OK 200 - Activate an API credential",
+ "description" : "Example response for activating an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description" : {
+ "summary" : "Update split configuration description",
+ "description" : "Example request for updating the description of a split configuration",
+ "value" : {
+ "description" : "Updated description for the split configuration"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description-200" : {
+ "summary" : "Split configuration description updated",
+ "description" : "Example response after updating the description of a split configuration",
+ "value" : {
+ "description" : "Updated description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule" : {
+ "summary" : "Update the conditions in split configuration rule",
+ "description" : "Example request for updating the conditions of a rule in a split configuration",
+ "value" : {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "shopperInteraction" : "ANY"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule-200" : {
+ "summary" : "Split configuration rule updated",
+ "description" : "Example response after updating a rule in a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic" : {
+ "summary" : "Update the split logic",
+ "description" : "Example request for updating the split logic in a split configuration rule",
+ "value" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic-200" : {
+ "summary" : "Split logic updated",
+ "description" : "Example response after updating the split logic",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores" : {
+ "summary" : "Update store address.",
+ "description" : "Example request to update the address of a store",
+ "value" : {
+ "address" : {
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "postalCode" : "20251"
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating the store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration" : {
+ "summary" : "Add split configuration to store",
+ "description" : "Example request to add a split configuration to the store",
+ "value" : {
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration-200" : {
+ "summary" : "Split configuration added to store",
+ "description" : "Example response after adding a split confuguration to the store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ },
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-merchants-merchantId-terminalOrders-orderId-update-order" : {
+ "summary" : "Update a terminal order",
+ "description" : "Example request to update an order for terminal products",
+ "value" : {
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "patch-merchants-merchantId-terminalOrders-orderId-update-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-73536B20665526704F30792642212044452F714622375D477270",
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34931234567",
+ "email" : "Rita.Perengano@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : "",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook" : {
+ "summary" : "Activate the webhook",
+ "description" : "Example request for activating a webhook configuration.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook-200" : {
+ "summary" : "OK 200 - Activate the webhook",
+ "description" : "Example response for activating a webhook configuration.",
+ "value" : {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores" : {
+ "summary" : "Update store address.",
+ "description" : "Example request to update the address of a store",
+ "value" : {
+ "address" : {
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "postalCode" : "20251"
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores-splitConfiguration" : {
+ "summary" : "Add split configuration to store",
+ "description" : "Example request to add a split configuration to the store",
+ "value" : {
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ }
+ },
+ "patch-stores-storeId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-stores-storeId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-stores-storeId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-stores-storeId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin" : {
+ "summary" : "Add an allowed origin for the API credential",
+ "description" : "Example request for adding an allowed origin for the API credential.",
+ "value" : {
+ "domain" : "https://www.eu.mystore.com"
+ }
+ },
+ "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200" : {
+ "summary" : "OK 200 - Add an allowed origin for the API credential",
+ "description" : "Example response for adding an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "post-companies-companyId-apiCredentials-post-company-credential" : {
+ "summary" : "Add an API credential",
+ "description" : "Example request for adding an API credential.",
+ "value" : {
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "allowedOrigins" : [
+ "https://www.mystore.com"
+ ],
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_AU",
+ "YOUR_MERCHANT_ACCOUNT_EU",
+ "YOUR_MERCHANT_ACCOUNT_US"
+ ]
+ }
+ },
+ "post-companies-companyId-apiCredentials-post-company-credential-200" : {
+ "summary" : "OK 200 - Add an API credential",
+ "description" : "Example response for adding an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "apiKey" : "YOUR_API_KEY",
+ "password" : "YOUR_PASSWORD",
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_AU",
+ "YOUR_MERCHANT_ACCOUNT_EU",
+ "YOUR_MERCHANT_ACCOUNT_US"
+ ]
+ }
+ },
+ "post-companies-companyId-shippingLocations-create-shipping-location" : {
+ "summary" : "Create a shipping location",
+ "description" : "Example request to create a shipping location",
+ "value" : {
+ "name" : "YOUR_COMPANY Rokin depot",
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : "",
+ "country" : "NL"
+ },
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ }
+ }
+ },
+ "post-companies-companyId-shippingLocations-create-shipping-location-200" : {
+ "summary" : "Shipping location created",
+ "description" : "Example response after creating a shipping location",
+ "value" : {
+ "id" : "S2-7973536B20662642215526704F302044452F714622375D476169",
+ "name" : "YOUR_COMPANY Rokin depot",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : ""
+ }
+ }
+ },
+ "post-companies-companyId-terminalOrders-create-order" : {
+ "summary" : "Create an order",
+ "description" : "Example request to create an order for terminal products",
+ "value" : {
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "shippingLocationId" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "billingEntityId" : "Company.YOUR_COMPANY",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-terminalOrders-create-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-terminalOrders-orderId-cancel-cancel-order-200" : {
+ "summary" : "Terminal order cancelled",
+ "description" : "Example response after cancelling an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "Netherlands"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "Netherlands"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-users-create-user" : {
+ "summary" : "Create a user",
+ "description" : "Example request to create a user on the company level",
+ "value" : {
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "username" : "johnsmith",
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "roles" : [
+ "Merchant standard role",
+ "Merchant admin"
+ ],
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-users-create-user-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a user on the company level",
+ "value" : {
+ "id" : "S2-5C334C6770",
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "username" : "johnsmith",
+ "roles" : [
+ "Merchant standard role",
+ "Merchant admin"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users/S2-5C334C6770"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-post-company-webhook" : {
+ "summary" : "Add a webhook configuration",
+ "description" : "Example request for adding a standard webhook configuration.",
+ "value" : {
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "username" : "YOUR_USER",
+ "password" : "YOUR_PASSWORD",
+ "active" : true,
+ "communicationFormat" : "soap",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "populateSoapActionHeader" : false,
+ "filterMerchantAccountType" : "includeAccounts",
+ "filterMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-post-company-webhook-200" : {
+ "summary" : "OK 200 - Add a webhook configuration",
+ "description" : "Example response for adding a webhook configuration.",
+ "value" : {
+ "id" : "S2-6933523D2772",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "includeAccounts",
+ "filterMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ],
+ "username" : "myuser",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "soap",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "certificateAlias" : "signed-test.adyen.com_2023",
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/test"
+ }
+ }
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-generateHmac-post-company-webhook-generateHmac-200" : {
+ "summary" : "OK 200 - Generate a webhook HMAC key",
+ "description" : "Example response for generating a webhook HMAC.",
+ "value" : {
+ "hmacKey" : "7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902"
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test" : {
+ "summary" : "Test a webhook notification",
+ "description" : "Example request for testing a webhook notification.",
+ "value" : {
+ "notification" : {
+ "paymentMethod" : "visa",
+ "eventCode" : "AUTHORISATION",
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 2000
+ },
+ "reason" : "Authorize visa payment",
+ "success" : true
+ },
+ "types" : [
+ "CUSTOM"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
+ "summary" : "OK 200 - Test a webhook notification",
+ "description" : "Example response for testing a webhook notification.",
+ "value" : {
+ "data" : [
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_AU",
+ "output" : "",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_AU\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "657 ms",
+ "status" : "success"
+ },
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_EU",
+ "output" : "",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_EU\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "590 ms",
+ "status" : "success"
+ },
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_US",
+ "output" : "",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_US\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "248 ms",
+ "status" : "success"
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin" : {
+ "summary" : "Add an allowed origin for the API credential",
+ "description" : "Example request for adding an allowed origin for the API credential.",
+ "value" : {
+ "domain" : "https://www.eu.mystore.com"
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200" : {
+ "summary" : "OK 200 - Add an allowed origin for the API credential",
+ "description" : "Example response for adding an allowed origin for the API credential.",
+ "value" : {
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-post-merchant-credential" : {
+ "summary" : "Add an API credential",
+ "description" : "Example request for adding an API credential.",
+ "value" : {
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "allowedOrigins" : [
+ "https://www.mystore.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-post-merchant-credential-200" : {
+ "summary" : "OK 200 - Add an API credential",
+ "description" : "Example response for adding an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ },
+ "apiKey" : "YOUR_API_KEY",
+ "password" : "YOUR_PASSWORD"
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method" : {
+ "summary" : "Request a payment method",
+ "description" : "Example request to add a payment method",
+ "value" : {
+ "type" : "visa",
+ "currencies" : [
+ "USD"
+ ],
+ "countries" : [
+ "US"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after sending a request to add a payment method",
+ "value" : {
+ "id" : "PM3227C223224K5FH84M8CBNH",
+ "type" : "visa",
+ "countries" : [
+ "US"
+ ],
+ "currencies" : [
+ "USD"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model" : {
+ "summary" : "Request to add Swish",
+ "description" : "Example request to add Swish with a partner model setup",
+ "value" : {
+ "businessLineId" : "BL322KV223222D5F8H2J4BQ6C",
+ "storeId" : "ST322LJ223223K5F4SQNR9XL5",
+ "type" : "swish",
+ "swish" : {
+ "swishNumber" : "1231111111"
+ },
+ "currencies" : [
+ "SEK"
+ ],
+ "countries" : [
+ "SE"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after sending a request to add Swish in a partner model setup",
+ "value" : {
+ "id" : "PM3227C223224K5FH84M8CBNH",
+ "businessLineId" : "BL322KV223222D5F8H2J4BQ6C",
+ "storeId" : "ST322LJ223223K5F4SQNR9XL5",
+ "type" : "swish",
+ "countries" : [
+ "SE"
+ ],
+ "currencies" : [
+ "SEK"
+ ],
+ "swish" : {
+ "swishNumber" : "1231111111"
+ }
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain" : {
+ "summary" : "Add an Apple Pay domain",
+ "description" : "Example request to add an Apple Pay domain",
+ "value" : {
+ "domains" : [
+ "https://example.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain-202" : {
+ "summary" : "Apple Pay domain requested - 202 OK",
+ "description" : "Example response after sending a request to add an Apple Pay domain",
+ "value" : {
+ "domains" : [
+ "https://example.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-shippingLocations-create-shipping-location" : {
+ "summary" : "Create a shipping location",
+ "description" : "Example request to create a shipping location",
+ "value" : {
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : "",
+ "country" : "ES"
+ },
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34 93 1234567",
+ "email" : "Rita.Perengano@company.com"
+ }
+ }
+ },
+ "post-merchants-merchantId-shippingLocations-create-shipping-location-200" : {
+ "summary" : "Shipping location created",
+ "description" : "Example response after creating a shipping location",
+ "value" : {
+ "id" : "S2-73536B20665526704F30792642212044452F714622375D477270",
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34931234567",
+ "email" : "Rita.Perengano@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : ""
+ }
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-post-splitConfiguration" : {
+ "summary" : "Create a split configuration",
+ "description" : "Example request to create a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "paymentMethod" : "ANY",
+ "shopperInteraction" : "ANY",
+ "fundingSource" : "ANY",
+ "currency" : "ANY",
+ "splitLogic" : {
+ "paymentFee" : "deductFromLiableAccount",
+ "chargeback" : "deductFromLiableAccount",
+ "tip" : "addToOneBalanceAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-post-splitConfiguration-200" : {
+ "summary" : "Split configuration created",
+ "description" : "Example response after creating a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule" : {
+ "summary" : "Add rule to a split configuration",
+ "description" : "Example request to add a rule to a split configuration",
+ "value" : {
+ "paymentMethod" : "visa",
+ "shopperInteraction" : "POS",
+ "fundingSource" : "ANY",
+ "currency" : "USD",
+ "splitLogic" : {
+ "paymentFee" : "deductFromLiableAccount",
+ "chargeback" : "deductFromLiableAccount",
+ "tip" : "addToOneBalanceAccount",
+ "remainder" : "addToLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule-200" : {
+ "summary" : "Split configuration created",
+ "description" : "Example response after creating a split configuration",
+ "value" : {
+ "description" : "My first split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "USD",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "POS",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "post-merchants-merchantId-stores-post-stores" : {
+ "summary" : "Create a store under the merchant account specified in the path.",
+ "description" : "Example request to create a store",
+ "value" : {
+ "description" : "City centre store",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "1813702551707653",
+ "reference" : "Spring_store_2",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ }
+ }
+ },
+ "post-merchants-merchantId-stores-post-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-create-order" : {
+ "summary" : "Create an order",
+ "description" : "Example request to create an order for terminal products",
+ "value" : {
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "shippingLocationId" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "billingEntityId" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-create-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-orderId-cancel-cancel-order-200" : {
+ "summary" : "Terminal order cancelled",
+ "description" : "Example response after cancelling an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-users-create-user" : {
+ "summary" : "Create a user",
+ "description" : "Example request to create a user on the merchant level",
+ "value" : {
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "username" : "johnsmith",
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "roles" : [
+ "Merchant standard role"
+ ]
+ }
+ },
+ "post-merchants-merchantId-users-create-user-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a user on the merchant level",
+ "value" : {
+ "id" : "S2-3B3C3C3B22",
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "username" : "johnsmith",
+ "roles" : [
+ "Merchant standard role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users/S2-3B3C3C3B22"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-webhooks-post-merchant-webhook" : {
+ "summary" : "Add a webhook configuration",
+ "description" : "Example request for adding a standard webhook configuration.",
+ "value" : {
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "username" : "YOUR_USER",
+ "password" : "YOUR_PASSWORD",
+ "active" : true,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "populateSoapActionHeader" : false
+ }
+ },
+ "post-merchants-merchantId-webhooks-post-merchant-webhook-200" : {
+ "summary" : "OK 200 - Add a webhook configuration",
+ "description" : "Example response for adding a webhook configuration.",
+ "value" : {
+ "id" : "S2-31433949437F",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "myuser",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "certificateAlias" : "signed-test.adyen.com_2023",
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/test"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-generateHmac-post-merchant-webhook-generateHmac-200" : {
+ "summary" : "OK 200 - Generate a webhook HMAC key",
+ "description" : "Example response for generating a webhook HMAC.",
+ "value" : {
+ "hmacKey" : "7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902"
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test" : {
+ "summary" : "Test a webhook notification",
+ "description" : "Example request for testing a webhook notification.",
+ "value" : {
+ "notification" : {
+ "paymentMethod" : "visa",
+ "eventCode" : "AUTHORISATION",
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 1000
+ },
+ "reason" : "Authorize visa payment",
+ "success" : true
+ },
+ "types" : [
+ "CUSTOM"
+ ]
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
+ "summary" : "OK 200 - Test a webhook notification",
+ "description" : "Example response for testing a webhook notification.",
+ "value" : {
+ "data" : [
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT",
+ "output" : "",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T17:02:03+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT\",\"merchantReference\":\"4TZLD23Y\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"E05WW50L6IOBRGA0\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "532 ms",
+ "status" : "success"
+ }
+ ]
+ }
+ },
+ "post-merchants-post-merchants" : {
+ "summary" : "Create a merchant account for an Adyen for Platforms Manage integration",
+ "description" : "Example request for creating a merchant account",
+ "value" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "legalEntityId" : "YOUR_LEGAL_ENTITY_ID",
+ "businessLineId" : "YOUR_BUSINESS_LINE_ID",
+ "description" : "YOUR_DESCRIPTION",
+ "reference" : "YOUR_OWN_REFERENCE"
+ }
+ },
+ "post-merchants-post-merchants-200" : {
+ "summary" : "Merchant account created",
+ "description" : "Example response for creating a merchant account",
+ "value" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "legalEntityId" : "YOUR_LEGAL_ENTITY_ID",
+ "businessLineId" : "YOUR_BUSINESS_LINE_ID",
+ "description" : "YOUR_DESCRIPTION",
+ "reference" : "YOUR_OWN_REFERENCE",
+ "id" : "YOUR_OWN_REFERENCE"
+ }
+ },
+ "post-stores-post-stores" : {
+ "summary" : "Create a store",
+ "description" : "Example request to create a store",
+ "value" : {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "description" : "City centre store",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ }
+ }
+ },
+ "post-stores-post-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "post-terminals-scheduleActions-install-app" : {
+ "summary" : "Schedule installing an Android app",
+ "description" : "Example request to schedule installing an Android app",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "InstallAndroidApp",
+ "appId" : "ANDA422LZ223223K5F694GCCF732K8"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-install-app-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after scheduling the installation of an Android app",
+ "value" : {
+ "actionDetails" : {
+ "appId" : "ANDA422LZ223223K5F694GCCF732K8",
+ "type" : "InstallAndroidApp"
+ },
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "storeId" : "",
+ "items" : [
+ {
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "terminalId" : "S1E-000150183300032"
+ },
+ {
+ "id" : "TRAC4224X22338VQ5GD4CQJCQT5PC2",
+ "terminalId" : "S1E-000150183300033"
+ },
+ {
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ ],
+ "terminalsWithErrors" : {
+
+ },
+ "totalScheduled" : 3,
+ "totalErrors" : 0
+ }
+ },
+ "post-terminals-scheduleActions-uninstall-cert" : {
+ "summary" : "Schedule uninstalling an Android certificate",
+ "description" : "Example request to schedule uninstalling an Android certificate",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "UninstallAndroidCertificate",
+ "certificateId" : "ANDC422LZ223223K5F78NVN9SL4VPH"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-uninstall-cert-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after scheduling the removal of an Android certificate",
+ "value" : {
+ "actionDetails" : {
+ "certificateId" : "ANDC422LZ223223K5F78NVN9SL4VPH",
+ "type" : "UninstallAndroidCertificate"
+ },
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "storeId" : "",
+ "items" : [
+ {
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "terminalId" : "S1E-000150183300032"
+ },
+ {
+ "id" : "TRAC4224X22338VQ5GD4CQJCQT5PC2",
+ "terminalId" : "S1E-000150183300033"
+ },
+ {
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ ],
+ "terminalsWithErrors" : {
+
+ },
+ "totalScheduled" : 3,
+ "totalErrors" : 0
+ }
+ },
+ "post-terminals-scheduleActions-verification-error" : {
+ "summary" : "Invalid terminal ID in the request",
+ "description" : "Example request to see what validation errors look like",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-11T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "InstallAndroidApp",
+ "appId" : "ANDA422LZ223223K5F694GCCF621J7"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-verification-error-422" : {
+ "summary" : "Response code - 422 Unprocessable Entity",
+ "description" : "Example response for failed verification of terminal IDs",
+ "value" : {
+ "type" : "https://docs.adyen.com/errors/unprocessable-entity",
+ "errorCode" : "02_005",
+ "title" : "Terminal ID verification failed.",
+ "status" : 422,
+ "detail" : "Terminal IDs are empty"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/MgmtApi.json b/modules/openapi-generator/src/test/resources/3_0/jetbrains/MgmtApi.json
new file mode 100644
index 000000000000..3b8a3c9e03fa
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/MgmtApi.json
@@ -0,0 +1,28623 @@
+{
+ "openapi" : "3.1.0",
+ "servers" : [
+ {
+ "url" : "https://management-test.adyen.com/v3"
+ }
+ ],
+ "info" : {
+ "version" : "3",
+ "x-publicVersion" : true,
+ "title" : "Management API",
+ "description" : "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to this version of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v3/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v3\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/release-notes/management-api) to find out what changed in this version!",
+ "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
+ "contact" : {
+ "name" : "Adyen Developer Experience team",
+ "url" : "https://github.com/Adyen/adyen-openapi"
+ }
+ },
+ "x-groups" : [
+ "Account - company level",
+ "Account - merchant level",
+ "Account - store level",
+ "Payout settings - merchant level",
+ "Users - company level",
+ "Users - merchant level",
+ "My API credential",
+ "API credentials - company level",
+ "API credentials - merchant level",
+ "API key - company level",
+ "API key - merchant level",
+ "Client key - company level",
+ "Client key - merchant level",
+ "Allowed origins - company level",
+ "Allowed origins - merchant level",
+ "Webhooks - company level",
+ "Webhooks - merchant level",
+ "Payment methods - merchant level",
+ "Terminals - terminal level",
+ "Terminal actions - company level",
+ "Terminal actions - terminal level",
+ "Terminal orders - company level",
+ "Terminal orders - merchant level",
+ "Terminal settings - company level",
+ "Terminal settings - merchant level",
+ "Terminal settings - store level",
+ "Terminal settings - terminal level",
+ "Android files - company level",
+ "Split configuration - merchant level"
+ ],
+ "tags" : [
+ {
+ "name" : "Account - company level"
+ },
+ {
+ "name" : "Account - merchant level"
+ },
+ {
+ "name" : "Account - store level"
+ },
+ {
+ "name" : "Payout settings - merchant level"
+ },
+ {
+ "name" : "Users - company level"
+ },
+ {
+ "name" : "Users - merchant level"
+ },
+ {
+ "name" : "My API credential"
+ },
+ {
+ "name" : "API credentials - company level"
+ },
+ {
+ "name" : "API credentials - merchant level"
+ },
+ {
+ "name" : "API key - company level"
+ },
+ {
+ "name" : "API key - merchant level"
+ },
+ {
+ "name" : "Client key - company level"
+ },
+ {
+ "name" : "Client key - merchant level"
+ },
+ {
+ "name" : "Allowed origins - company level"
+ },
+ {
+ "name" : "Allowed origins - merchant level"
+ },
+ {
+ "name" : "Webhooks - company level"
+ },
+ {
+ "name" : "Webhooks - merchant level"
+ },
+ {
+ "name" : "Payment methods - merchant level"
+ },
+ {
+ "name" : "Terminals - terminal level"
+ },
+ {
+ "name" : "Terminal actions - company level"
+ },
+ {
+ "name" : "Terminal actions - terminal level"
+ },
+ {
+ "name" : "Terminal orders - company level"
+ },
+ {
+ "name" : "Terminal orders - merchant level"
+ },
+ {
+ "name" : "Terminal settings - company level"
+ },
+ {
+ "name" : "Terminal settings - merchant level"
+ },
+ {
+ "name" : "Terminal settings - store level"
+ },
+ {
+ "name" : "Terminal settings - terminal level"
+ },
+ {
+ "name" : "Android files - company level"
+ },
+ {
+ "name" : "Split configuration - merchant level"
+ }
+ ],
+ "paths" : {
+ "/companies" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a list of company accounts",
+ "description" : "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Account read",
+ "operationId" : "get-companies",
+ "x-groupName" : "Account - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listCompanyAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a company account",
+ "description" : "Returns the company account specified in the path. Your API credential must have access to the company account. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-companies-companyId",
+ "x-groupName" : "Account - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getCompanyAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Company"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidApps" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get a list of Android apps",
+ "description" : "Returns a list of the Android apps that are available for the company identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-androidApps",
+ "x-groupName" : "Android files - company level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listAndroidApps",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The package name that uniquely identifies the Android app.",
+ "name" : "packageName",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The version number of the app.",
+ "name" : "versionCode",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-androidApps-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidAppsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Upload Android App",
+ "description" : "Uploads an Android APK file to Adyen.\nThe maximum APK file size is 200 MB.\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read and write\n\n>By choosing to upload, install, or run any third-party applications on an Adyen payment terminal, you accept full responsibility and liability for any consequences of uploading, installing, or running any such applications.",
+ "x-addedInVersion" : "3",
+ "operationId" : "post-companies-companyId-androidApps",
+ "x-groupName" : "Android files - company level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "uploadAndroidApp",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidApps/{id}" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get Android app",
+ "description" : "Returns the details of the Android app identified in the path. \nThese apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write",
+ "operationId" : "get-companies-companyId-androidApps-id",
+ "x-groupName" : "Android files - company level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getAndroidApp",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the app.",
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidApp"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/androidCertificates" : {
+ "get" : {
+ "tags" : [
+ "Android files - company level"
+ ],
+ "summary" : "Get a list of Android certificates",
+ "description" : "Returns a list of the Android certificates that are available for the company identified in the path.\nTypically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Android files read\n* Management API—Android files read and write\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-androidCertificates",
+ "x-groupName" : "Android files - company level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAndroidCertificates",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The name of the certificate.",
+ "name" : "certificateName",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-androidCertificates-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AndroidCertificatesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials" : {
+ "get" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Get a list of API credentials",
+ "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials",
+ "x-groupName" : "API credentials - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listApiCredentials",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyApiCredentialsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Create an API credential.",
+ "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins.\n\nThe response includes several types of authentication details:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials",
+ "x-groupName" : "API credentials - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-credential" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-post-company-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-credential" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-post-company-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyApiCredentialResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}" : {
+ "get" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Get an API credential",
+ "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId",
+ "x-groupName" : "API credentials - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "API credentials - company level"
+ ],
+ "summary" : "Update an API credential.",
+ "description" : "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "patch-companies-companyId-apiCredentials-apiCredentialId",
+ "x-groupName" : "API credentials - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-credential" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-credential" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Get a list of allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-groupName" : "Allowed origins - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origins" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Create an allowed origin",
+ "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-groupName" : "Allowed origins - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Delete an allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "delete-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-groupName" : "Allowed origins - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "deleteAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Allowed origins - company level"
+ ],
+ "summary" : "Get an allowed origin",
+ "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-groupName" : "Allowed origins - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origin" : {
+ "$ref" : "#/components/examples/get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey" : {
+ "post" : {
+ "tags" : [
+ "API key - company level"
+ ],
+ "summary" : "Generate new API key",
+ "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateApiKey",
+ "x-groupName" : "API key - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewApiKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateApiKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "Client key - company level"
+ ],
+ "summary" : "Generate new client key",
+ "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-companies-companyId-apiCredentials-apiCredentialId-generateClientKey",
+ "x-groupName" : "Client key - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/billingEntities" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of billing entities",
+ "description" : "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-billingEntities",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listBillingEntities",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the billing entity.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-billingEntities-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/BillingEntitiesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/merchants" : {
+ "get" : {
+ "tags" : [
+ "Account - company level"
+ ],
+ "summary" : "Get a list of merchant accounts",
+ "description" : "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-companies-companyId-merchants",
+ "x-groupName" : "Account - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listMerchantAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-merchants-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/shippingLocations" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of shipping locations",
+ "description" : "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-shippingLocations",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listShippingLocations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the shipping location.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of locations to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of locations to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-shippingLocations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocationsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Create a shipping location",
+ "description" : "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-companies-companyId-shippingLocations",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createShippingLocation",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-companies-companyId-shippingLocations-create-shipping-location-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalActions" : {
+ "get" : {
+ "tags" : [
+ "Terminal actions - company level"
+ ],
+ "summary" : "Get a list of terminal actions",
+ "description" : "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-terminalActions",
+ "x-groupName" : "Terminal actions - company level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalActions",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "Returns terminal actions with the specified status. \nAllowed values: **pending**, **successful**, **failed**, **cancelled**, **tryLater**.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminal actions of the specified type. \nAllowed values: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, **UninstallAndroidCertificate**.",
+ "name" : "type",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalActions-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListExternalTerminalActionsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalActions/{actionId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal actions - company level"
+ ],
+ "summary" : "Get terminal action",
+ "description" : "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path.\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read\n* Management API—Terminal actions read and write",
+ "operationId" : "get-companies-companyId-terminalActions-actionId",
+ "x-groupName" : "Terminal actions - company level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalAction",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the terminal action.",
+ "name" : "actionId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalActions-actionId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ExternalTerminalAction"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. \n\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-companies-companyId-terminalLogos",
+ "x-groupName" : "Terminal settings - company level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). \n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the Adyen PSP level, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-companies-companyId-terminalLogos",
+ "x-groupName" : "Terminal settings - company level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalModels" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of terminal models",
+ "description" : "Returns a list of payment terminal models that the company identified in the path has access to.\nThe response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalModels",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalModels",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalModels-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalModelsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of orders",
+ "description" : "Returns a lists of terminal products orders for the company identified in the path.\nTo filter the list, use one or more of the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalOrders",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "listOrders",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Your purchase order number.",
+ "name" : "customerOrderReference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of orders to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of orders to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalOrders-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrdersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Create an order",
+ "description" : "Creates an order for payment terminal products for the company identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
+ "operationId" : "post-companies-companyId-terminalOrders",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "createOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-create-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-create-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders/{orderId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get an order",
+ "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalOrders-orderId",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 8,
+ "x-methodName" : "getOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalOrders-orderId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Update an order",
+ "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "patch-companies-companyId-terminalOrders-orderId",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 9,
+ "x-methodName" : "updateOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalOrders-orderId-update-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalOrders-orderId-update-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalOrders/{orderId}/cancel" : {
+ "post" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Cancel an order",
+ "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-companies-companyId-terminalOrders-orderId-cancel",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 10,
+ "x-methodName" : "cancelOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "cancel-order" : {
+ "$ref" : "#/components/examples/post-companies-companyId-terminalOrders-orderId-cancel-cancel-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalProducts" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - company level"
+ ],
+ "summary" : "Get a list of terminal products",
+ "description" : "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.\n \nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-companies-companyId-terminalProducts",
+ "x-groupName" : "Terminal orders - company level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listTerminalProducts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**",
+ "name" : "country",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400**",
+ "name" : "terminalModelId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of products to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of products to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalProducts-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalProductsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-companies-companyId-terminalSettings",
+ "x-groupName" : "Terminal settings - company level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-companies-companyId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - company level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-companies-companyId-terminalSettings",
+ "x-groupName" : "Terminal settings - company level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/users" : {
+ "get" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Get a list of users",
+ "description" : "Returns the list of users for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-companies-companyId-users",
+ "x-groupName" : "Users - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listUsers",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to return.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The partial or complete username to select all users that match.",
+ "name" : "username",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCompanyUsersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Create a new user",
+ "description" : "Creates the user for the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "post-companies-companyId-users",
+ "x-groupName" : "Users - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createNewUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-companies-companyId-users-create-user"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-companies-companyId-users-create-user-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyUserResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/users/{userId}" : {
+ "get" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Get user details",
+ "description" : "Returns user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-companies-companyId-users-userId",
+ "x-groupName" : "Users - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Users - company level"
+ ],
+ "summary" : "Update user details",
+ "description" : "Updates user details for the `userId` and the `companyId` identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "patch-companies-companyId-users-userId",
+ "x-groupName" : "Users - company level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks" : {
+ "get" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "List all webhooks",
+ "description" : "Lists all webhook configurations for the company account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-companies-companyId-webhooks",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAllWebhooks",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-company-webhooks" : {
+ "$ref" : "#/components/examples/get-companies-companyId-webhooks-get-company-webhooks-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListWebhooksResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Set up a webhook",
+ "description" : "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "setUpWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-post-company-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-post-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}" : {
+ "delete" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Remove a webhook",
+ "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "delete-companies-companyId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "removeWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Get a webhook",
+ "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-companies-companyId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account).",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-company-webhook" : {
+ "$ref" : "#/components/examples/get-companies-companyId-webhooks-webhookId-get-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Update a webhook",
+ "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "patch-companies-companyId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-webhook" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-webhooks-webhookId-patch-company-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-company-webhook" : {
+ "$ref" : "#/components/examples/patch-companies-companyId-webhooks-webhookId-patch-company-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}/generateHmac" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Generate an HMAC key",
+ "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks-webhookId-generateHmac",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "generateHmacKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-generateHmac" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-generateHmac-post-company-webhook-generateHmac-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateHmacKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/companies/{companyId}/webhooks/{webhookId}/test" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - company level"
+ ],
+ "summary" : "Test a webhook",
+ "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-companies-companyId-webhooks-webhookId-test",
+ "x-groupName" : "Webhooks - company level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "testWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-test" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestCompanyWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the company account.",
+ "name" : "companyId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-company-webhook-test" : {
+ "$ref" : "#/components/examples/post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me" : {
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get API credential details",
+ "description" : "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request.\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredentialDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/MeApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request.\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me-allowedOrigins",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Add allowed origin",
+ "description" : "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "post-me-allowedOrigins",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "addAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateAllowedOriginRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Remove allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "delete-me-allowedOrigins-originId",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "removeAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Get allowed origin details",
+ "description" : "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path.\nThe API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials).\n\nYou can make this request with any of the Management API roles.",
+ "operationId" : "get-me-allowedOrigins-originId",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOriginDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/me/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "My API credential"
+ ],
+ "summary" : "Generate a client key",
+ "description" : "Generates a new [client key](https://docs.adyen.com/development-resources/client-side-authentication/) used to authenticate requests from your payment environment.\nYou can use the new client key a few minutes after generating it.\nThe old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-me-generateClientKey",
+ "x-groupName" : "My API credential",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants" : {
+ "get" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Get a list of merchant accounts",
+ "description" : "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-merchants",
+ "x-groupName" : "Account - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listMerchantAccounts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Create a merchant account",
+ "description" : "Creates a merchant account for the company account specified in the request.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
+ "operationId" : "post-merchants",
+ "x-groupName" : "Account - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchants" : {
+ "$ref" : "#/components/examples/post-merchants-post-merchants"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchants" : {
+ "$ref" : "#/components/examples/post-merchants-post-merchants-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}" : {
+ "get" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Get a merchant account",
+ "description" : "Returns the merchant account specified in the path. Your API credential must have access to the merchant account.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read",
+ "operationId" : "get-merchants-merchantId",
+ "x-groupName" : "Account - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Merchant"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/activate" : {
+ "post" : {
+ "tags" : [
+ "Account - merchant level"
+ ],
+ "summary" : "Request to activate a merchant account",
+ "description" : "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write",
+ "operationId" : "post-merchants-merchantId-activate",
+ "x-groupName" : "Account - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "requestToActivateMerchantAccount",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RequestActivationResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials" : {
+ "get" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Get a list of API credentials",
+ "description" : "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials",
+ "x-groupName" : "API credentials - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listApiCredentials",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantApiCredentialsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Create an API credential",
+ "description" : "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential.\n\nThe response includes the:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication.\n* [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication.\n\n> Make sure you store the API key securely in your system. You won't be able to retrieve it later.\n\nIf your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials",
+ "x-groupName" : "API credentials - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-credential" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-post-merchant-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-credential" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-post-merchant-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateApiCredentialResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}" : {
+ "get" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Get an API credential",
+ "description" : "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId",
+ "x-groupName" : "API credentials - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "API credentials - merchant level"
+ ],
+ "summary" : "Update an API credential",
+ "description" : "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "patch-merchants-merchantId-apiCredentials-apiCredentialId",
+ "x-groupName" : "API credentials - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateApiCredential",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-credential" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantApiCredentialRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-credential" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins" : {
+ "get" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Get a list of allowed origins",
+ "description" : "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-groupName" : "Allowed origins - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listAllowedOrigins",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origin" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Create an allowed origin",
+ "description" : "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins",
+ "x-groupName" : "Allowed origins - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-allowed-origin" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOriginsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}" : {
+ "delete" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Delete an allowed origin",
+ "description" : "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "delete-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-groupName" : "Allowed origins - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "deleteAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Allowed origins - merchant level"
+ ],
+ "summary" : "Get an allowed origin",
+ "description" : "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId",
+ "x-groupName" : "Allowed origins - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getAllowedOrigin",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the allowed origin.",
+ "name" : "originId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-allowed-origins" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origins-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey" : {
+ "post" : {
+ "tags" : [
+ "API key - merchant level"
+ ],
+ "summary" : "Generate new API key",
+ "description" : "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateApiKey",
+ "x-groupName" : "API key - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewApiKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateApiKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey" : {
+ "post" : {
+ "tags" : [
+ "Client key - merchant level"
+ ],
+ "summary" : "Generate new client key",
+ "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write",
+ "operationId" : "post-merchants-merchantId-apiCredentials-apiCredentialId-generateClientKey",
+ "x-groupName" : "Client key - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "generateNewClientKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the API credential.",
+ "name" : "apiCredentialId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateClientKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/billingEntities" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of billing entities",
+ "description" : "Returns the billing entities of the merchant account identified in the path.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-billingEntities",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listBillingEntities",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the billing entity.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-billingEntities-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/BillingEntitiesResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get all payment methods",
+ "description" : "Returns details for all payment methods of the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getAllPaymentMethods",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store for which to return the payment methods.",
+ "name" : "storeId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the Business Line for which to return the payment methods.",
+ "name" : "businessLineId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethodResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Request a payment method",
+ "description" : "Sends a request to add a new payment method to the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "post-merchants-merchantId-paymentMethodSettings",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "requestPaymentMethod",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-payment-method-partner-model" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethodSetupInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-payment-method-partner-model" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get payment method details",
+ "description" : "Returns details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getPaymentMethodDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Update a payment method",
+ "description" : "Updates payment method details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "patch-merchants-merchantId-paymentMethodSettings-paymentMethodId",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updatePaymentMethod",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdatePaymentMethodInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains" : {
+ "post" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Add an Apple Pay domain",
+ "description" : "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n",
+ "operationId" : "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "addApplePayDomain",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-applepay-domain" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains" : {
+ "get" : {
+ "tags" : [
+ "Payment methods - merchant level"
+ ],
+ "summary" : "Get Apple Pay domains",
+ "description" : "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n",
+ "operationId" : "get-merchants-merchantId-paymentMethodSettings-paymentMethodId-getApplePayDomains",
+ "x-groupName" : "Payment methods - merchant level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "getApplePayDomains",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payment method.",
+ "name" : "paymentMethodId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/payoutSettings" : {
+ "get" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Get a list of payout settings",
+ "description" : "Returns the list of payout settings for the merchant account identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read",
+ "operationId" : "get-merchants-merchantId-payoutSettings",
+ "x-groupName" : "Payout settings - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listPayoutSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettingsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Add a payout setting",
+ "description" : "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.\n\nIf you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "post-merchants-merchantId-payoutSettings",
+ "x-groupName" : "Payout settings - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "addPayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettingsRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}" : {
+ "delete" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Delete a payout setting",
+ "description" : "Deletes the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "delete-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-groupName" : "Payout settings - merchant level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "deletePayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Get a payout setting",
+ "description" : "Returns the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read",
+ "operationId" : "get-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-groupName" : "Payout settings - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getPayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Payout settings - merchant level"
+ ],
+ "summary" : "Update a payout setting",
+ "description" : "Updates the payout setting identified in the path. You can enable or disable the payout setting.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write",
+ "operationId" : "patch-merchants-merchantId-payoutSettings-payoutSettingsId",
+ "x-groupName" : "Payout settings - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "updatePayoutSetting",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdatePayoutSettingsRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the payout setting.",
+ "name" : "payoutSettingsId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/shippingLocations" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of shipping locations",
+ "description" : "Returns the shipping locations for the merchant account identified in the path.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-shippingLocations",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listShippingLocations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The name of the shipping location.",
+ "name" : "name",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of locations to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of locations to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-shippingLocations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocationsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Create a shipping location",
+ "description" : "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-merchants-merchantId-shippingLocations",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createShippingLocation",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-shippingLocations-create-shipping-location"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-shipping-location" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-shippingLocations-create-shipping-location-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations" : {
+ "get" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Get a list of split configurations",
+ "description" : "Returns the list of split configurations for the merchant account.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "get-merchants-merchantId-splitConfigurations",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "listSplitConfigurations",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-splitConfigurations-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfigurationList"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Create a split configuration",
+ "description" : "Creates a split configuration for the merchant account specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "post-merchants-merchantId-splitConfigurations",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-post-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-post-splitConfiguration-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}" : {
+ "delete" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Delete a split configuration",
+ "description" : "Deletes the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 8,
+ "x-methodName" : "deleteSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Get a split configuration",
+ "description" : "Returns the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "get-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getSplitConfiguration",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-splitConfigurations-splitConfigurationId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update split configuration description",
+ "description" : "Changes the description of the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "updateSplitConfigurationDescription",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-description" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-description" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Create a rule",
+ "description" : "Creates a rule in the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "post-merchants-merchantId-splitConfigurations-splitConfigurationId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "createRule",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfigurationRule"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}" : {
+ "delete" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Delete a split configuration rule",
+ "description" : "Deletes the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "delete-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 9,
+ "x-methodName" : "deleteSplitConfigurationRule",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update split conditions",
+ "description" : "Changes the conditions of the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "updateSplitConditions",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationRuleRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration rule.",
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}" : {
+ "patch" : {
+ "tags" : [
+ "Split configuration - merchant level"
+ ],
+ "summary" : "Update the split logic",
+ "description" : "Changes the split logic specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write",
+ "operationId" : "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId",
+ "x-groupName" : "Split configuration - merchant level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "updateSplitLogic",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule-splitLogic" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateSplitConfigurationLogicRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration.",
+ "name" : "splitConfigurationId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration rule.",
+ "name" : "ruleId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the split configuration split.",
+ "name" : "splitLogicId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-splitConfiguration-rule-splitLogic" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a list of stores",
+ "description" : "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-merchants-merchantId-stores",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listStoresByMerchantId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The reference of the store.",
+ "name" : "reference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListStoresResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Create a store",
+ "description" : "Creates a store for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "post-merchants-merchantId-stores",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createStoreByMerchantId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-stores-post-stores"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/StoreCreationRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-stores-post-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{reference}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-stores-reference-terminalLogos",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-reference-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-stores-reference-terminalLogos",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{reference}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-merchants-merchantId-stores-reference-terminalSettings",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-reference-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-merchants-merchantId-stores-reference-terminalSettings",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The reference that identifies the store.",
+ "name" : "reference",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/stores/{storeId}" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a store",
+ "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-merchants-merchantId-stores-storeId",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-stores-storeId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Update a store",
+ "description" : "Updates the store identified in the path. You can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "patch-merchants-merchantId-stores-storeId",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateStoreRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-200"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-terminalLogos",
+ "x-groupName" : "Terminal settings - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the company account, specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-terminalLogos",
+ "x-groupName" : "Terminal settings - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalModels" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of terminal models",
+ "description" : "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalModels",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminalModels",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalModels-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalModelsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of orders",
+ "description" : "Returns a list of terminal products orders for the merchant account identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalOrders",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "listOrders",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Your purchase order number.",
+ "name" : "customerOrderReference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.",
+ "name" : "status",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of orders to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of orders to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalOrders-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrdersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Create an order",
+ "description" : "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-terminals/order-terminals/#sales-order-steps) in your Customer Area.",
+ "operationId" : "post-merchants-merchantId-terminalOrders",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "createOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-create-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-create-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders/{orderId}" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get an order",
+ "description" : "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalOrders-orderId",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 8,
+ "x-methodName" : "getOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalOrders-orderId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Update an order",
+ "description" : "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "patch-merchants-merchantId-terminalOrders-orderId",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 9,
+ "x-methodName" : "updateOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalOrders-orderId-update-order"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrderRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "update-order" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalOrders-orderId-update-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalOrders/{orderId}/cancel" : {
+ "post" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Cancel an order",
+ "description" : "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write",
+ "operationId" : "post-merchants-merchantId-terminalOrders-orderId-cancel",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 10,
+ "x-methodName" : "cancelOrder",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the order.",
+ "name" : "orderId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "cancel-order" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-terminalOrders-orderId-cancel-cancel-order-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalProducts" : {
+ "get" : {
+ "tags" : [
+ "Terminal orders - merchant level"
+ ],
+ "summary" : "Get a list of terminal products",
+ "description" : "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write",
+ "operationId" : "get-merchants-merchantId-terminalProducts",
+ "x-groupName" : "Terminal orders - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listTerminalProducts",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**",
+ "name" : "country",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**",
+ "name" : "terminalModelId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of products to skip.",
+ "name" : "offset",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of products to return.",
+ "name" : "limit",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalProducts-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalProductsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-merchants-merchantId-terminalSettings",
+ "x-groupName" : "Terminal settings - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - merchant level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the merchant account identified in the path.\nThese settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-merchants-merchantId-terminalSettings",
+ "x-groupName" : "Terminal settings - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/users" : {
+ "get" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Get a list of users",
+ "description" : "Returns a list of users associated with the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-merchants-merchantId-users",
+ "x-groupName" : "Users - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "listUsers",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The partial or complete username to select all users that match.",
+ "name" : "username",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListMerchantUsersResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Create a new user",
+ "description" : "Creates a user for the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "post-merchants-merchantId-users",
+ "x-groupName" : "Users - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "createNewUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-users-create-user"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "create-user" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-users-create-user-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateUserResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/users/{userId}" : {
+ "get" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Get user details",
+ "description" : "Returns user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "get-merchants-merchantId-users-userId",
+ "x-groupName" : "Users - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "getUserDetails",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Users - merchant level"
+ ],
+ "summary" : "Update a user",
+ "description" : "Updates user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n",
+ "operationId" : "patch-merchants-merchantId-users-userId",
+ "x-groupName" : "Users - merchant level",
+ "x-sortIndex" : 0,
+ "x-methodName" : "updateUser",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantUserRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "Unique identifier of the merchant.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the user.",
+ "name" : "userId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks" : {
+ "get" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "List all webhooks",
+ "description" : "Lists all webhook configurations for the merchant account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-merchants-merchantId-webhooks",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "listAllWebhooks",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-merchant-webhooks" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-webhooks-get-merchant-webhooks-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListWebhooksResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Set up a webhook",
+ "description" : "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "setUpWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-post-merchant-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateMerchantWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-post-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}" : {
+ "delete" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Remove a webhook",
+ "description" : "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "delete-merchants-merchantId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "removeWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "get" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Get a webhook",
+ "description" : "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write",
+ "operationId" : "get-merchants-merchantId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "get-merchant-webhook" : {
+ "$ref" : "#/components/examples/get-merchants-merchantId-webhooks-webhookId-get-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Update a webhook",
+ "description" : "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "patch-merchants-merchantId-webhooks-webhookId",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-webhook" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateMerchantWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-merchant-webhook" : {
+ "$ref" : "#/components/examples/patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Webhook"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}/generateHmac" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Generate an HMAC key",
+ "description" : "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures).\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks-webhookId-generateHmac",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "generateHmacKey",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-generateHmac" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-generateHmac-post-merchant-webhook-generateHmac-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/GenerateHmacKeyResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/merchants/{merchantId}/webhooks/{webhookId}/test" : {
+ "post" : {
+ "tags" : [
+ "Webhooks - merchant level"
+ ],
+ "summary" : "Test a webhook",
+ "description" : "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write",
+ "operationId" : "post-merchants-merchantId-webhooks-webhookId-test",
+ "x-groupName" : "Webhooks - merchant level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "testWebhook",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-test" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Unique identifier of the webhook configuration.",
+ "name" : "webhookId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-merchant-webhook-test" : {
+ "$ref" : "#/components/examples/post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TestWebhookResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "204" : {
+ "description" : "No Content - the request has been successfully processed, but there is no additional content."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a list of stores",
+ "description" : "Returns a list of stores. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-stores",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "listStores",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 10 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The reference of the store.",
+ "name" : "reference",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The unique identifier of the merchant account.",
+ "name" : "merchantId",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListStoresResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "post" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Create a store",
+ "description" : "Creates a store for the merchant account specified in the request.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "post-stores",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "createStore",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-stores-post-stores"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/StoreCreationWithMerchantCodeRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "post-stores" : {
+ "$ref" : "#/components/examples/post-stores-post-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}" : {
+ "get" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Get a store",
+ "description" : "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write",
+ "operationId" : "get-stores-storeId",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "getStoreById",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Account - store level"
+ ],
+ "summary" : "Update a store",
+ "description" : "Updates the store identified in the path.\nYou can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write",
+ "operationId" : "patch-stores-storeId",
+ "x-groupName" : "Account - store level",
+ "x-sortIndex" : 7,
+ "x-methodName" : "updateStoreById",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores"
+ },
+ "patch-stores-splitConfiguration" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores-splitConfiguration"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateStoreRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "patch-stores" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-patch-stores-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Store"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-stores-storeId-terminalLogos",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "getTerminalLogoByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update the terminal logo",
+ "description" : "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-stores-storeId-terminalLogos",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "updateTerminalLogoByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T.",
+ "name" : "model",
+ "in" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/stores/{storeId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-stores-storeId-terminalSettings",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "getTerminalSettingsByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-stores-storeId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - store level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-stores-storeId-terminalSettings",
+ "x-groupName" : "Terminal settings - store level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "updateTerminalSettingsByStoreId",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the store.",
+ "name" : "storeId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals" : {
+ "get" : {
+ "tags" : [
+ "Terminals - terminal level"
+ ],
+ "summary" : "Get a list of terminals",
+ "description" : "Returns the payment terminals that the API credential has access to and that match the query parameters. \nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API — Terminal actions read",
+ "operationId" : "get-terminals",
+ "x-groupName" : "Terminals - terminal level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "listTerminals",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.",
+ "name" : "searchQuery",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.",
+ "name" : "otpQuery",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).",
+ "name" : "countries",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.",
+ "name" : "merchantIds",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID.",
+ "name" : "storeIds",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*.",
+ "name" : "brandModels",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ {
+ "description" : "The number of the page to fetch.",
+ "name" : "pageNumber",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ {
+ "description" : "The number of items to have on a page, maximum 100. The default is 20 items on a page.",
+ "name" : "pageSize",
+ "in" : "query",
+ "required" : false,
+ "schema" : {
+ "format" : "int32",
+ "type" : "integer"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ListTerminalsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/scheduleActions" : {
+ "post" : {
+ "tags" : [
+ "Terminal actions - terminal level"
+ ],
+ "summary" : "Create a terminal action",
+ "description" : "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. \n\nThe following restrictions apply:\n* You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. \n* The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. \n* If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal actions read and write",
+ "operationId" : "post-terminals-scheduleActions",
+ "x-groupName" : "Terminal actions - terminal level",
+ "x-sortIndex" : 1,
+ "x-methodName" : "createTerminalAction",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "install-app" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-install-app"
+ },
+ "uninstall-cert" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-uninstall-cert"
+ },
+ "verification-error" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-verification-error"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ScheduleTerminalActionsRequest"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "install-app" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-install-app-200"
+ },
+ "uninstall-cert" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-uninstall-cert-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/ScheduleTerminalActionsResponse"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "verification-error" : {
+ "$ref" : "#/components/examples/post-terminals-scheduleActions-verification-error-422"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/reassign" : {
+ "post" : {
+ "tags" : [
+ "Terminals - terminal level"
+ ],
+ "summary" : "Reassign a terminal",
+ "description" : "Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Assign Terminal",
+ "x-addedInVersion" : "3",
+ "operationId" : "post-terminals-terminalId-reassign",
+ "x-groupName" : "Terminals - terminal level",
+ "x-sortIndex" : 2,
+ "x-methodName" : "reassignTerminal",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalReassignmentRequest"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "No Content - look at the actual response code for the status of the request. "
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/terminalLogos" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Get the terminal logo",
+ "description" : "Returns the logo that is configured for the payment terminal identified in the path.\nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write",
+ "operationId" : "get-terminals-terminalId-terminalLogos",
+ "x-groupName" : "Terminal settings - terminal level",
+ "x-sortIndex" : 4,
+ "x-methodName" : "getTerminalLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-terminalId-terminalLogos-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Update the logo",
+ "description" : "Updates the logo for the payment terminal identified in the path.\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write",
+ "operationId" : "patch-terminals-terminalId-terminalLogos",
+ "x-groupName" : "Terminal settings - terminal level",
+ "x-sortIndex" : 6,
+ "x-methodName" : "updateLogo",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "remove-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-remove-logo-200"
+ },
+ "upload-logo" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalLogos-upload-logo-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/Logo"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ },
+ "/terminals/{terminalId}/terminalSettings" : {
+ "get" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Get terminal settings",
+ "description" : "Returns the settings that are configured for the payment terminal identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "get-terminals-terminalId-terminalSettings",
+ "x-groupName" : "Terminal settings - terminal level",
+ "x-sortIndex" : 3,
+ "x-methodName" : "getTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "success" : {
+ "$ref" : "#/components/examples/get-terminals-terminalId-terminalSettings-success-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ },
+ "patch" : {
+ "tags" : [
+ "Terminal settings - terminal level"
+ ],
+ "summary" : "Update terminal settings",
+ "description" : "Updates the settings that are configured for the payment terminal identified in the path.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter.\n* Objects that are not included in the request are not updated.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role:\n* Management API—Terminal settings Advanced read and write",
+ "operationId" : "patch-terminals-terminalId-terminalSettings",
+ "x-groupName" : "Terminal settings - terminal level",
+ "x-sortIndex" : 5,
+ "x-methodName" : "updateTerminalSettings",
+ "security" : [
+ {
+ "BasicAuth" : [
+ ]
+ },
+ {
+ "ApiKeyAuth" : [
+ ]
+ }
+ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ }
+ },
+ "parameters" : [
+ {
+ "description" : "The unique identifier of the payment terminal.",
+ "name" : "terminalId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "content" : {
+ "application/json" : {
+ "examples" : {
+ "add-eap-peap-and-psk-wifi-profiles" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200"
+ },
+ "add-eap-tls-wifi-profile" : {
+ "$ref" : "#/components/examples/patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200"
+ }
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/TerminalSettings"
+ }
+ }
+ },
+ "description" : "OK - the request has succeeded."
+ },
+ "400" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Bad Request - a problem reading or understanding the request."
+ },
+ "401" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unauthorized - authentication required."
+ },
+ "403" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Forbidden - insufficient permissions to process the request."
+ },
+ "422" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Unprocessable Entity - a request validation error."
+ },
+ "500" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestServiceError"
+ }
+ }
+ },
+ "description" : "Internal Server Error - the server could not process the request."
+ }
+ }
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "AdditionalCommission" : {
+ "properties" : {
+ "balanceAccountId" : {
+ "description" : "Unique identifier of the balance account to which the additional commission is booked.",
+ "type" : "string"
+ },
+ "fixedAmount" : {
+ "description" : "A fixed commission fee, in minor units.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "variablePercentage" : {
+ "description" : "A variable commission fee, in basis points.",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "AdditionalSettings" : {
+ "properties" : {
+ "includeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "properties" : {
+ "additionalProperties" : {
+ "type" : "boolean"
+ },
+ "description" : "Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled.\nFor example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured.",
+ "type" : "object"
+ }
+ },
+ "type" : "object"
+ },
+ "AdditionalSettingsResponse" : {
+ "properties" : {
+ "excludeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will not be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "includeEventCodes" : {
+ "description" : "Object containing list of event codes for which the notifcation will be sent. ",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "properties" : {
+ "additionalProperties" : {
+ "type" : "boolean"
+ },
+ "description" : "Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled.\nFor example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured.",
+ "type" : "object"
+ }
+ },
+ "type" : "object"
+ },
+ "Address" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "companyName" : {
+ "description" : "The name of the company.",
+ "type" : "string"
+ },
+ "country" : {
+ "description" : "The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada. \n\nApplicable for the following countries:\n- Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ },
+ "streetAddress" : {
+ "description" : "The name of the street, and the house or building number.",
+ "type" : "string"
+ },
+ "streetAddress2" : {
+ "description" : "Additional address details, if any.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "AfterpayTouchInfo" : {
+ "properties" : {
+ "supportUrl" : {
+ "description" : "Support Url",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportUrl"
+ ],
+ "type" : "object"
+ },
+ "AllowedOrigin" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the allowed origin.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "domain" : {
+ "description" : "Domain of the allowed origin.",
+ "example" : "https://adyen.com",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the allowed origin.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "domain"
+ ],
+ "type" : "object"
+ },
+ "AllowedOriginsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of allowed origins.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Amount" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "value",
+ "currency"
+ ],
+ "type" : "object"
+ },
+ "AndroidApp" : {
+ "properties" : {
+ "description" : {
+ "description" : "The description that was provided when uploading the app. The description is not shown on the terminal.",
+ "type" : "string"
+ },
+ "errorCode" : {
+ "description" : "The error code of the app. It exists if the status is error or invalid.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the app.",
+ "type" : "string"
+ },
+ "label" : {
+ "description" : "The app name that is shown on the terminal.",
+ "type" : "string"
+ },
+ "packageName" : {
+ "description" : "The package name that uniquely identifies the Android app.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the app. Possible values: \n* `processing`: the app is being signed and converted to a format that the terminal can handle.\n* `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements).\n* `invalid`: there is something wrong with the APK file of the app.\n* `ready`: the app has been signed and converted.\n* `archived`: the app is no longer available.",
+ "type" : "string"
+ },
+ "versionCode" : {
+ "description" : "The version number of the app.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "versionName" : {
+ "description" : "The app version number that is shown on the terminal.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "AndroidAppsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Apps uploaded for Android payment terminals.",
+ "items" : {
+ "$ref" : "#/components/schemas/AndroidApp"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "AndroidCertificate" : {
+ "properties" : {
+ "description" : {
+ "description" : "The description that was provided when uploading the certificate.",
+ "type" : "string"
+ },
+ "extension" : {
+ "description" : "The file format of the certificate, as indicated by the file extension. For example, **.cert** or **.pem**.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the certificate.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The file name of the certificate. For example, **mycert**.",
+ "type" : "string"
+ },
+ "notAfter" : {
+ "description" : "The date when the certificate stops to be valid.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "notBefore" : {
+ "description" : "The date when the certificate starts to be valid.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the certificate.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id"
+ ],
+ "type" : "object"
+ },
+ "AndroidCertificatesResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Uploaded Android certificates for Android payment terminals.",
+ "items" : {
+ "$ref" : "#/components/schemas/AndroidCertificate"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "ApiCredentialLinks" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "List of allowed origins.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "company" : {
+ "description" : "Company account that the API credential is linked to. Only present for company-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateApiKey" : {
+ "description" : "Generates a new API key. When you generate a new one, the existing key remains valid for 24 hours. ",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateClientKey" : {
+ "description" : "Generates a new client key, used to authenticate client-side requests. When you generate a new one, the existing key remains valid for 24 hours.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "merchant" : {
+ "description" : "The merchant account that the API credential is linked to. Only present for merchant-level API credentials.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "ApplePayInfo" : {
+ "properties" : {
+ "domains" : {
+ "description" : "The list of merchant domains. Maximum: 99 domains per request.\n\nFor more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live).",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "domains"
+ ],
+ "type" : "object"
+ },
+ "BcmcInfo" : {
+ "properties" : {
+ "enableBcmcMobile" : {
+ "description" : "Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled.",
+ "type" : "boolean"
+ },
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "BillingEntitiesResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of legal entities that can be used for the billing of orders.",
+ "items" : {
+ "$ref" : "#/components/schemas/BillingEntity"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "BillingEntity" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address details of the billing entity.",
+ "$ref" : "#/components/schemas/Address"
+ },
+ "email" : {
+ "description" : "The email address of the billing entity.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the billing entity, for use as `billingEntityId` when creating an order.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The unique name of the billing entity.",
+ "type" : "string"
+ },
+ "taxId" : {
+ "description" : "The tax number of the billing entity.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CardholderReceipt" : {
+ "properties" : {
+ "headerForAuthorizedReceipt" : {
+ "description" : "A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler`",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CartesBancairesInfo" : {
+ "properties" : {
+ "siret" : {
+ "description" : "Cartes Bancaires SIRET. Format: 14 digits.",
+ "type" : "string"
+ },
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "required" : [
+ "siret"
+ ],
+ "type" : "object"
+ },
+ "ClearpayInfo" : {
+ "properties" : {
+ "supportUrl" : {
+ "description" : "Support Url",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportUrl"
+ ],
+ "type" : "object"
+ },
+ "Commission" : {
+ "properties" : {
+ "fixedAmount" : {
+ "description" : "A fixed commission fee, in minor units.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "variablePercentage" : {
+ "description" : "A variable commission fee, in basis points.",
+ "format" : "int64",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "Company" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this company.",
+ "$ref" : "#/components/schemas/CompanyLinks"
+ },
+ "dataCenters" : {
+ "description" : "List of available data centers.\n\nAdyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.",
+ "items" : {
+ "$ref" : "#/components/schemas/DataCenter"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description for the company account, maximum 300 characters",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The legal or trading name of the company.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to the account",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the company account.\n\nPossible values:\n\n* **Active**: Users can log in. Processing and payout capabilities depend on the status of the merchant account.\n* **Inactive**: Users can log in. Payment processing and payouts are disabled.\n* **Closed**: The company account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CompanyApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has explicit access to. \n If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "CompanyLinks" : {
+ "properties" : {
+ "apiCredentials" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "users" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "webhooks" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "CompanyUser" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "Configuration" : {
+ "properties" : {
+ "brand" : {
+ "description" : "Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). ",
+ "type" : "string"
+ },
+ "currencies" : {
+ "description" : "Currency, and surcharge percentage or amount.",
+ "items" : {
+ "$ref" : "#/components/schemas/Currency"
+ },
+ "type" : "array"
+ },
+ "sources" : {
+ "description" : "Funding source. Possible values:\n* **Credit**\n* **Debit**",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "brand",
+ "currencies"
+ ],
+ "type" : "object"
+ },
+ "Connectivity" : {
+ "properties" : {
+ "simcardStatus" : {
+ "description" : "Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity.\n\nPossible values:\n* **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings.\n* **INVENTORY**: the SIM card is not activated. The terminal can't use cellular connectivity.",
+ "enum" : [
+ "ACTIVATED",
+ "INVENTORY"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Contact" : {
+ "properties" : {
+ "email" : {
+ "description" : "The individual's email address.",
+ "type" : "string"
+ },
+ "firstName" : {
+ "description" : "The individual's first name.",
+ "type" : "string"
+ },
+ "infix" : {
+ "description" : "The infix in the individual's name, if any.",
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The individual's last name.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The individual's phone number, specified as 10-14 digits with an optional `+` prefix.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateAllowedOriginRequest" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the allowed origin.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "domain" : {
+ "description" : "Domain of the allowed origin.",
+ "example" : "https://adyen.com",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the allowed origin.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "domain"
+ ],
+ "type" : "object"
+ },
+ "CreateApiCredentialResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "apiKey" : {
+ "description" : "The API key for the API credential that was created.",
+ "type" : "string"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "The password for the API credential that was created.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active",
+ "password",
+ "apiKey"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyApiCredentialRequest" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateCompanyApiCredentialResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "apiKey" : {
+ "description" : "The API key for the API credential that was created.",
+ "type" : "string"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "The password for the API credential that was created.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active",
+ "password",
+ "apiKey",
+ "associatedMerchantAccounts"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.\n\nAllowed length: 1—80 characters.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The user's email address that will be their username. Must be the same as the one in the `email` field.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "email",
+ "username"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyUserResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "CreateCompanyWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are filtered when configuring the webhook. \n\nPossible values:\n* **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.\n* **includeAccounts** : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts** : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n\n",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "url",
+ "active",
+ "communicationFormat",
+ "type",
+ "filterMerchantAccountType",
+ "filterMerchantAccounts"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantApiCredentialRequest" : {
+ "properties" : {
+ "allowedOrigins" : {
+ "description" : "The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateMerchantRequest" : {
+ "properties" : {
+ "businessLineId" : {
+ "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration.",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "legalEntityId" : {
+ "description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). Required for an Adyen for Platforms Manage integration.",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Sets the pricing plan for the merchant account. Required for an Adyen for Platforms Manage integration. Your Adyen contact will provide the values that you can use.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference for the merchant account. To make this reference the unique identifier of the merchant account, your Adyen contact can set up a template on your company account. The template can have 6 to 255 characters with upper- and lower-case letters, underscores, and numbers. When your company account has a template, then the `reference` is required and must be unique within the company account.",
+ "type" : "string"
+ },
+ "salesChannels" : {
+ "description" : "List of sales channels that the merchant will process payments with",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "companyId"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantResponse" : {
+ "properties" : {
+ "businessLineId" : {
+ "description" : "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines).",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the merchant account. If Adyen set up a template for the `reference`, then the `id` will have the same value as the `reference` that you sent in the request. Otherwise, the value is generated by Adyen.",
+ "type" : "string"
+ },
+ "legalEntityId" : {
+ "description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Partner pricing plan for the merchant, applicable for merchants under AfP managed company accounts.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference for the merchant account.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "CreateMerchantUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.\n\nAllowed length: 1—80 characters.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The user's email address that will be their username. Must be the same as the one in the `email` field.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "email",
+ "username"
+ ],
+ "type" : "object"
+ },
+ "CreateMerchantWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook that is being created. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **rreq-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "url",
+ "active",
+ "communicationFormat",
+ "type"
+ ],
+ "type" : "object"
+ },
+ "CreateUserResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "Currency" : {
+ "properties" : {
+ "amount" : {
+ "description" : "Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "currencyCode" : {
+ "description" : "Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**.",
+ "type" : "string"
+ },
+ "percentage" : {
+ "description" : "Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**.",
+ "format" : "double",
+ "type" : "number"
+ }
+ },
+ "required" : [
+ "currencyCode"
+ ],
+ "type" : "object"
+ },
+ "CustomNotification" : {
+ "properties" : {
+ "amount" : {
+ "description" : "The amount of the payment that the notification is about. Set the value in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "$ref" : "#/components/schemas/Amount"
+ },
+ "eventCode" : {
+ "description" : "The event that caused the notification to be sent.Currently supported values:\n* **AUTHORISATION**\n* **CANCELLATION**\n* **REFUND**\n* **CAPTURE**\n* **REPORT_AVAILABLE**\n* **CHARGEBACK**\n* **REQUEST_FOR_INFORMATION**\n* **NOTIFICATION_OF_CHARGEBACK**\n* **NOTIFICATIONTEST**\n* **ORDER_OPENED**\n* **ORDER_CLOSED**\n* **CHARGEBACK_REVERSED**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**",
+ "type" : "string"
+ },
+ "eventDate" : {
+ "description" : "The time of the event. Format: [ISO 8601](http://www.w3.org/TR/NOTE-datetime), YYYY-MM-DDThh:mm:ssTZD.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "merchantReference" : {
+ "description" : "Your reference for the custom test notification.",
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method for the payment that the notification is about. Possible values:\n* **amex**\n* **visa**\n* **mc**\n* **maestro**\n* **bcmc**\n* **paypal**\n * **sms**\n * **bankTransfer_NL**\n* **bankTransfer_DE**\n* **bankTransfer_BE**\n* **ideal**\n* **elv**\n* **sepadirectdebit**\n",
+ "type" : "string"
+ },
+ "reason" : {
+ "description" : "A descripton of what caused the notification.",
+ "type" : "string"
+ },
+ "success" : {
+ "description" : "The outcome of the event which the notification is about. Set to either **true** or **false**. ",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "DataCenter" : {
+ "properties" : {
+ "livePrefix" : {
+ "description" : "The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) for your live endpoint. Each data center has its own live URL prefix.\n\nThis field is empty for requests made in the test environment.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name assigned to a data center, for example **EU** for the European data center. Possible values are:\n\n* **default**: the European data center. This value is always returned in the test environment. \n* **AU**\n* **EU**\n* **US**",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "EventUrl" : {
+ "properties" : {
+ "eventLocalUrls" : {
+ "description" : "One or more local URLs to send event notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ },
+ "eventPublicUrls" : {
+ "description" : "One or more public URLs to send event notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ExternalTerminalAction" : {
+ "properties" : {
+ "actionType" : {
+ "description" : "The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, or **UninstallAndroidCertificate**.",
+ "type" : "string"
+ },
+ "config" : {
+ "description" : "Technical information about the terminal action.",
+ "type" : "string"
+ },
+ "confirmedAt" : {
+ "description" : "The date and time when the action was carried out.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique ID of the terminal action.",
+ "type" : "string"
+ },
+ "result" : {
+ "description" : "The result message for the action.",
+ "type" : "string"
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action was scheduled to happen.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the terminal action: **pending**, **successful**, **failed**, **cancelled**, or **tryLater**.",
+ "type" : "string"
+ },
+ "terminalId" : {
+ "description" : "The unique ID of the terminal that the action applies to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "File" : {
+ "properties" : {
+ "data" : {
+ "description" : "The certificate content converted to a Base64-encoded string.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the certificate. Must be unique across Wi-Fi profiles.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "data"
+ ],
+ "type" : "object"
+ },
+ "GenerateApiKeyResponse" : {
+ "properties" : {
+ "apiKey" : {
+ "description" : "The generated API key.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "apiKey"
+ ],
+ "type" : "object"
+ },
+ "GenerateClientKeyResponse" : {
+ "properties" : {
+ "clientKey" : {
+ "description" : "Generated client key",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "clientKey"
+ ],
+ "type" : "object"
+ },
+ "GenerateHmacKeyResponse" : {
+ "properties" : {
+ "hmacKey" : {
+ "description" : "The HMAC key generated for this webhook.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "hmacKey"
+ ],
+ "type" : "object"
+ },
+ "GenericPmWithTdiInfo" : {
+ "properties" : {
+ "transactionDescription" : {
+ "description" : "Information regarding the transaction description.",
+ "$ref" : "#/components/schemas/TransactionDescriptionInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "GiroPayInfo" : {
+ "properties" : {
+ "supportEmail" : {
+ "description" : "The email address of merchant support.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "supportEmail"
+ ],
+ "type" : "object"
+ },
+ "GooglePayInfo" : {
+ "properties" : {
+ "merchantId" : {
+ "description" : "Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters.",
+ "maxLength" : 20,
+ "minLength" : 16,
+ "type" : "string"
+ },
+ "reuseMerchantId" : {
+ "description" : "Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: **false**.",
+ "type" : "boolean"
+ }
+ },
+ "required" : [
+ "merchantId"
+ ],
+ "type" : "object"
+ },
+ "Gratuity" : {
+ "properties" : {
+ "allowCustomAmount" : {
+ "description" : "Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown.",
+ "type" : "boolean"
+ },
+ "currency" : {
+ "description" : "The currency that the tipping settings apply to.",
+ "type" : "string"
+ },
+ "predefinedTipEntries" : {
+ "description" : "Tipping options the shopper can choose from if `usePredefinedTipEntries` is **true**. The maximum number of predefined options is four, or three plus the option to enter a custom tip.\nThe options can be a mix of:\n\n- A percentage of the transaction amount. Example: **5%**\n- A tip amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "usePredefinedTipEntries" : {
+ "description" : "Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**).",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Hardware" : {
+ "properties" : {
+ "displayMaximumBackLight" : {
+ "description" : "The brightness of the display when the terminal is being used, expressed as a percentage.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "restartHour" : {
+ "description" : "The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal Minimum vaoue: 0, maximum value: 23.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "IdName" : {
+ "properties" : {
+ "id" : {
+ "description" : "The identifier of the terminal model.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the terminal model.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InstallAndroidAppDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "appId" : {
+ "description" : "The unique identifier of the app to be installed.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "InstallAndroidApp",
+ "description" : "Type of terminal action: Install an Android app.",
+ "enum" : [
+ "InstallAndroidApp"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InstallAndroidCertificateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "certificateId" : {
+ "description" : "The unique identifier of the certificate to be installed.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "InstallAndroidCertificate",
+ "description" : "Type of terminal action: Install an Android certificate.",
+ "enum" : [
+ "InstallAndroidCertificate"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "InvalidField" : {
+ "properties" : {
+ "message" : {
+ "description" : "Description of the validation error.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The field that has an invalid value.",
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The invalid value.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "name",
+ "value",
+ "message"
+ ],
+ "type" : "object"
+ },
+ "JSONObject" : {
+ "type" : "object"
+ },
+ "Key" : {
+ "properties" : {
+ "identifier" : {
+ "description" : "The unique identifier of the shared key.",
+ "type" : "string"
+ },
+ "passphrase" : {
+ "description" : "The secure passphrase to protect the shared key.",
+ "type" : "string"
+ },
+ "version" : {
+ "description" : "The version number of the shared key.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "KlarnaInfo" : {
+ "properties" : {
+ "autoCapture" : {
+ "description" : "Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**.",
+ "type" : "boolean"
+ },
+ "disputeEmail" : {
+ "description" : "The email address for disputes.",
+ "type" : "string"
+ },
+ "region" : {
+ "description" : "The region of operation. For example, **NA**, **EU**, **CH**, **AU**.",
+ "enum" : [
+ "NA",
+ "EU",
+ "CH",
+ "AU"
+ ],
+ "maxLength" : 2,
+ "minLength" : 2,
+ "type" : "string"
+ },
+ "supportEmail" : {
+ "description" : "The email address of merchant support.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "region",
+ "supportEmail",
+ "disputeEmail"
+ ],
+ "type" : "object"
+ },
+ "Links" : {
+ "properties" : {
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "LinksElement" : {
+ "properties" : {
+ "href" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ListCompanyApiCredentialsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of API credentials.",
+ "items" : {
+ "$ref" : "#/components/schemas/CompanyApiCredential"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListCompanyResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of companies.",
+ "items" : {
+ "$ref" : "#/components/schemas/Company"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListCompanyUsersResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of users.",
+ "items" : {
+ "$ref" : "#/components/schemas/CompanyUser"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListExternalTerminalActionsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The list of terminal actions.",
+ "items" : {
+ "$ref" : "#/components/schemas/ExternalTerminalAction"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ListMerchantApiCredentialsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of API credentials.",
+ "items" : {
+ "$ref" : "#/components/schemas/ApiCredential"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListMerchantResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of merchant accounts.",
+ "items" : {
+ "$ref" : "#/components/schemas/Merchant"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListMerchantUsersResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of users.",
+ "items" : {
+ "$ref" : "#/components/schemas/User"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListStoresResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "List of stores",
+ "items" : {
+ "$ref" : "#/components/schemas/Store"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListTerminalsResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of terminals and their details.",
+ "items" : {
+ "$ref" : "#/components/schemas/Terminal"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "ListWebhooksResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "accountReference" : {
+ "description" : "Reference to the account.",
+ "type" : "string"
+ },
+ "data" : {
+ "description" : "The list of webhooks configured for this account.",
+ "items" : {
+ "$ref" : "#/components/schemas/Webhook"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "Localization" : {
+ "properties" : {
+ "language" : {
+ "description" : "Language of the terminal.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Logo" : {
+ "properties" : {
+ "data" : {
+ "description" : "The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal.",
+ "maxLength" : 350000,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "MeApiCredential" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources linked to the API credential.",
+ "$ref" : "#/components/schemas/ApiCredentialLinks"
+ },
+ "active" : {
+ "description" : "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
+ "type" : "boolean"
+ },
+ "allowedIpAddresses" : {
+ "description" : "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "allowedOrigins" : {
+ "description" : "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
+ "items" : {
+ "$ref" : "#/components/schemas/AllowedOrigin"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has explicit access to. \n If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "clientKey" : {
+ "description" : "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
+ "type" : "string"
+ },
+ "companyName" : {
+ "description" : "Name of the company linked to the API credential.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "username" : {
+ "description" : "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "username",
+ "clientKey",
+ "allowedIpAddresses",
+ "roles",
+ "active"
+ ],
+ "type" : "object"
+ },
+ "MealVoucherFRInfo" : {
+ "properties" : {
+ "conecsId" : {
+ "description" : "Meal Voucher conecsId. Format: digits only",
+ "type" : "string"
+ },
+ "siret" : {
+ "description" : "Meal Voucher siret. Format: 14 digits.",
+ "maxLength" : 14,
+ "minLength" : 14,
+ "type" : "string"
+ },
+ "subTypes" : {
+ "description" : "The list of additional payment methods. Allowed values: **mealVoucher_FR_edenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "siret",
+ "conecsId",
+ "subTypes"
+ ],
+ "type" : "object"
+ },
+ "Merchant" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this merchant.",
+ "$ref" : "#/components/schemas/MerchantLinks"
+ },
+ "captureDelay" : {
+ "description" : "The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account.\n\nPossible values:\n* **Immediate**\n* **Manual**\n* Number of days from **1** to **29**",
+ "type" : "string"
+ },
+ "companyId" : {
+ "description" : "The unique identifier of the company account this merchant belongs to",
+ "type" : "string"
+ },
+ "dataCenters" : {
+ "description" : "List of available data centers.\n\nAdyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers.",
+ "items" : {
+ "$ref" : "#/components/schemas/DataCenter"
+ },
+ "type" : "array"
+ },
+ "defaultShopperInteraction" : {
+ "description" : "The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account.",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for the merchant account, maximum 300 characters",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the merchant account.",
+ "type" : "string"
+ },
+ "merchantCity" : {
+ "description" : "The city where the legal entity of this merchant account is registered.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The name of the legal entity associated with the merchant account.",
+ "type" : "string"
+ },
+ "pricingPlan" : {
+ "description" : "Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account.",
+ "type" : "string"
+ },
+ "primarySettlementCurrency" : {
+ "description" : "The currency of the country where the legal entity of this merchant account is registered. Format: [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, a legal entity based in the United States has USD as the primary settlement currency.",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Reference of the merchant account.",
+ "type" : "string"
+ },
+ "shopWebAddress" : {
+ "description" : "The URL for the ecommerce website used with this merchant account.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the merchant account.\n\nPossible values:\n\n* **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments.\n* **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled.\n* **InactiveWithModifications**: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts.\n* **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled.\n* **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "MerchantLinks" : {
+ "properties" : {
+ "apiCredentials" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "users" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "webhooks" : {
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self"
+ ],
+ "type" : "object"
+ },
+ "MinorUnitsMonetaryValue" : {
+ "properties" : {
+ "amount" : {
+ "description" : "The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "currencyCode" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Name" : {
+ "properties" : {
+ "firstName" : {
+ "description" : "The first name.",
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The last name.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "firstName",
+ "lastName"
+ ],
+ "type" : "object"
+ },
+ "Name2" : {
+ "properties" : {
+ "firstName" : {
+ "description" : "The first name.",
+ "type" : "string"
+ },
+ "lastName" : {
+ "description" : "The last name.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Nexo" : {
+ "properties" : {
+ "displayUrls" : {
+ "description" : "The list of local and public URLs to send display notifications to when using Terminal API.",
+ "$ref" : "#/components/schemas/NotificationUrl"
+ },
+ "encryptionKey" : {
+ "description" : "The key you share with Adyen to secure local communications when using Terminal API.",
+ "$ref" : "#/components/schemas/Key"
+ },
+ "eventUrls" : {
+ "description" : "The list of local and public URLs to send event notifications to when using Terminal API.",
+ "$ref" : "#/components/schemas/EventUrl"
+ },
+ "nexoEventUrls" : {
+ "deprecated" : true,
+ "x-deprecatedInVersion" : "1",
+ "x-deprecatedMessage" : "Use `eventUrls` instead.",
+ "description" : "One or more URLs to send event messages to when using Terminal API.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "notification" : {
+ "description" : "Configures the event notification button on the terminal screen, for example used for pay-at-table.",
+ "$ref" : "#/components/schemas/Notification"
+ }
+ },
+ "type" : "object"
+ },
+ "Notification" : {
+ "properties" : {
+ "showButton" : {
+ "description" : "Shows or hides the event notification button on the terminal screen.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "NotificationUrl" : {
+ "properties" : {
+ "localUrls" : {
+ "description" : "One or more local URLs to send notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ },
+ "publicUrls" : {
+ "description" : "One or more public URLs to send notifications to when using Terminal API.",
+ "items" : {
+ "$ref" : "#/components/schemas/Url"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "OfflineProcessing" : {
+ "properties" : {
+ "chipFloorLimit" : {
+ "description" : "The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "offlineSwipeLimits" : {
+ "description" : "The maximum offline transaction amount for swiped cards, in the specified currency.",
+ "items" : {
+ "$ref" : "#/components/schemas/MinorUnitsMonetaryValue"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Opi" : {
+ "properties" : {
+ "enablePayAtTable" : {
+ "description" : "Indicates if Pay at table is enabled.",
+ "type" : "boolean"
+ },
+ "payAtTableStoreNumber" : {
+ "description" : "The store number to use for Pay at Table.",
+ "type" : "string"
+ },
+ "payAtTableURL" : {
+ "description" : "The URL and port number used for Pay at Table communication.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "OrderItem" : {
+ "properties" : {
+ "id" : {
+ "description" : "The unique identifier of the product.",
+ "type" : "string"
+ },
+ "installments" : {
+ "description" : "The number of installments for the specified product `id`.",
+ "format" : "int64",
+ "type" : "integer"
+ },
+ "name" : {
+ "description" : "The name of the product.",
+ "type" : "string"
+ },
+ "quantity" : {
+ "description" : "The number of items with the specified product `id` included in the order.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "PaginationLinks" : {
+ "properties" : {
+ "first" : {
+ "description" : "The first page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "last" : {
+ "description" : "The last page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "next" : {
+ "description" : "The next page. Only present if there is a next page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "prev" : {
+ "description" : "The previous page. Only present if there is a previous page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "The current page.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self",
+ "first",
+ "last"
+ ],
+ "type" : "object"
+ },
+ "Passcodes" : {
+ "properties" : {
+ "adminMenuPin" : {
+ "description" : "The passcode for the Admin menu and the Settings menu.",
+ "maxLength" : 6,
+ "type" : "string"
+ },
+ "refundPin" : {
+ "description" : "The passcode for unreferenced refunds on standalone terminals.",
+ "maxLength" : 6,
+ "type" : "string"
+ },
+ "screenLockPin" : {
+ "description" : "The passcode to unlock the terminal screen after a timeout.",
+ "maxLength" : 6,
+ "minLength" : 4,
+ "type" : "string"
+ },
+ "txMenuPin" : {
+ "description" : "The passcode for the Transactions menu.",
+ "maxLength" : 6,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "PayAtTable" : {
+ "properties" : {
+ "authenticationMethod" : {
+ "description" : "Allowed authentication methods: Magswipe, Manual Entry.",
+ "enum" : [
+ "MAGSWIPE",
+ "MKE"
+ ],
+ "type" : "string"
+ },
+ "enablePayAtTable" : {
+ "description" : "Enable Pay at table.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "PayPalInfo" : {
+ "properties" : {
+ "directCapture" : {
+ "description" : "Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**.",
+ "type" : "boolean"
+ },
+ "payerId" : {
+ "description" : "PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters.",
+ "maxLength" : 13,
+ "minLength" : 13,
+ "type" : "string"
+ },
+ "subject" : {
+ "description" : "Your business email address.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "subject",
+ "payerId"
+ ],
+ "type" : "object"
+ },
+ "Payment" : {
+ "properties" : {
+ "contactlessCurrency" : {
+ "description" : "The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "hideMinorUnitsInCurrencies" : {
+ "description" : "Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217).",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "PaymentMethod" : {
+ "properties" : {
+ "afterpayTouch" : {
+ "description" : "Afterpay Touch details.",
+ "$ref" : "#/components/schemas/AfterpayTouchInfo"
+ },
+ "allowed" : {
+ "description" : "Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account.",
+ "type" : "boolean"
+ },
+ "applePay" : {
+ "description" : "Apple Pay details.",
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ },
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "businessLineId" : {
+ "description" : "The unique identifier of the business line.",
+ "type" : "string"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "clearpay" : {
+ "description" : "Clearpay details.",
+ "$ref" : "#/components/schemas/ClearpayInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "customRoutingFlags" : {
+ "description" : "The list of custom routing flags to route payment to the intended acquirer.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "enabled" : {
+ "description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
+ "type" : "boolean"
+ },
+ "giroPay" : {
+ "description" : "giropay details.",
+ "$ref" : "#/components/schemas/GiroPayInfo"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "googlePay" : {
+ "description" : "Google Pay details.",
+ "$ref" : "#/components/schemas/GooglePayInfo"
+ },
+ "id" : {
+ "description" : "The identifier of the resource.",
+ "type" : "string"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "klarna" : {
+ "description" : "Klarna details.",
+ "$ref" : "#/components/schemas/KlarnaInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mealVoucher_FR" : {
+ "description" : "Meal Voucher FR details.",
+ "$ref" : "#/components/schemas/MealVoucherFRInfo"
+ },
+ "paypal" : {
+ "description" : "PayPal details.",
+ "$ref" : "#/components/schemas/PayPalInfo"
+ },
+ "reference" : {
+ "description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
+ "maxLength" : 150,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel.",
+ "type" : "string"
+ },
+ "sofort" : {
+ "description" : "Sofort details.",
+ "$ref" : "#/components/schemas/SofortInfo"
+ },
+ "storeIds" : {
+ "x-addedInVersion" : "3",
+ "description" : "The unique identifier of the store for which to configure the payment method, if any.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "swish" : {
+ "description" : "Swish details.",
+ "$ref" : "#/components/schemas/SwishInfo"
+ },
+ "twint" : {
+ "description" : "Twint details.",
+ "$ref" : "#/components/schemas/TwintInfo"
+ },
+ "type" : {
+ "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
+ "type" : "string"
+ },
+ "verificationStatus" : {
+ "description" : "Payment method status. Possible values:\n* **valid**\n* **pending**\n* **invalid**\n* **rejected**",
+ "enum" : [
+ "valid",
+ "pending",
+ "invalid",
+ "rejected"
+ ],
+ "type" : "string"
+ },
+ "vipps" : {
+ "description" : "Vipps details.",
+ "$ref" : "#/components/schemas/VippsInfo"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "required" : [
+ "id"
+ ],
+ "type" : "object"
+ },
+ "PaymentMethodResponse" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Pagination references.",
+ "$ref" : "#/components/schemas/PaginationLinks"
+ },
+ "data" : {
+ "description" : "The list of supported payment methods and their details.",
+ "items" : {
+ "$ref" : "#/components/schemas/PaymentMethod"
+ },
+ "type" : "array"
+ },
+ "itemsTotal" : {
+ "description" : "Total number of items.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "pagesTotal" : {
+ "description" : "Total number of pages.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "typesWithErrors" : {
+ "description" : "Payment method types with errors.",
+ "items" : {
+ "enum" : [
+ "afterpaytouch",
+ "alipay",
+ "alipay_hk",
+ "amex",
+ "applepay",
+ "bcmc",
+ "blik",
+ "cartebancaire",
+ "clearpay",
+ "cup",
+ "diners",
+ "directdebit_GB",
+ "discover",
+ "ebanking_FI",
+ "eftpos_australia",
+ "elo",
+ "elocredit",
+ "elodebit",
+ "girocard",
+ "googlepay",
+ "hiper",
+ "hipercard",
+ "ideal",
+ "interac_card",
+ "jcb",
+ "klarna",
+ "klarna_account",
+ "klarna_paynow",
+ "maestro",
+ "mbway",
+ "mc",
+ "mcdebit",
+ "mealVoucher_FR",
+ "mobilepay",
+ "multibanco",
+ "onlineBanking_PL",
+ "paybybank",
+ "paypal",
+ "payshop",
+ "swish",
+ "trustly",
+ "twint",
+ "twint_pos",
+ "vipps",
+ "visa",
+ "visadebit",
+ "vpay",
+ "wechatpay",
+ "wechatpay_pos"
+ ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "itemsTotal",
+ "pagesTotal"
+ ],
+ "type" : "object"
+ },
+ "PaymentMethodSetupInfo" : {
+ "properties" : {
+ "afterpayTouch" : {
+ "description" : "Afterpay Touch details.",
+ "$ref" : "#/components/schemas/AfterpayTouchInfo"
+ },
+ "applePay" : {
+ "description" : "Apple Pay details.",
+ "$ref" : "#/components/schemas/ApplePayInfo"
+ },
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "businessLineId" : {
+ "description" : "The unique identifier of the business line.",
+ "type" : "string"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "clearpay" : {
+ "description" : "Clearpay details.",
+ "$ref" : "#/components/schemas/ClearpayInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "customRoutingFlags" : {
+ "description" : "The list of custom routing flags to route payment to the intended acquirer.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "giroPay" : {
+ "description" : "giropay details.",
+ "$ref" : "#/components/schemas/GiroPayInfo"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "googlePay" : {
+ "description" : "Google Pay details.",
+ "$ref" : "#/components/schemas/GooglePayInfo"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "klarna" : {
+ "description" : "Klarna details.",
+ "$ref" : "#/components/schemas/KlarnaInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mealVoucher_FR" : {
+ "description" : "Meal Voucher FR details.",
+ "$ref" : "#/components/schemas/MealVoucherFRInfo"
+ },
+ "paypal" : {
+ "description" : "PayPal details.",
+ "$ref" : "#/components/schemas/PayPalInfo"
+ },
+ "reference" : {
+ "description" : "Your reference for the payment method. Supported characters a-z, A-Z, 0-9.",
+ "maxLength" : 150,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.\n\nPossible values: **eCommerce**, **pos**, **contAuth**, and **moto**. ",
+ "enum" : [
+ "eCommerce",
+ "pos",
+ "moto",
+ "contAuth"
+ ],
+ "type" : "string"
+ },
+ "sofort" : {
+ "description" : "Sofort details.",
+ "$ref" : "#/components/schemas/SofortInfo"
+ },
+ "storeIds" : {
+ "x-addedInVersion" : "3",
+ "description" : "The unique identifier of the store for which to configure the payment method, if any.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "swish" : {
+ "description" : "Swish details.",
+ "$ref" : "#/components/schemas/SwishInfo"
+ },
+ "twint" : {
+ "description" : "Twint details.",
+ "$ref" : "#/components/schemas/TwintInfo"
+ },
+ "type" : {
+ "description" : "Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api).",
+ "enum" : [
+ "afterpaytouch",
+ "alipay",
+ "alipay_hk",
+ "amex",
+ "applepay",
+ "bcmc",
+ "blik",
+ "cartebancaire",
+ "clearpay",
+ "cup",
+ "diners",
+ "directdebit_GB",
+ "discover",
+ "ebanking_FI",
+ "eftpos_australia",
+ "elo",
+ "elocredit",
+ "elodebit",
+ "girocard",
+ "googlepay",
+ "hiper",
+ "hipercard",
+ "ideal",
+ "interac_card",
+ "jcb",
+ "klarna",
+ "klarna_account",
+ "klarna_paynow",
+ "maestro",
+ "mbway",
+ "mc",
+ "mcdebit",
+ "mealVoucher_FR",
+ "mobilepay",
+ "multibanco",
+ "onlineBanking_PL",
+ "paybybank",
+ "paypal",
+ "payshop",
+ "swish",
+ "trustly",
+ "twint",
+ "twint_pos",
+ "vipps",
+ "visa",
+ "visadebit",
+ "vpay",
+ "wechatpay",
+ "wechatpay_pos"
+ ],
+ "type" : "string"
+ },
+ "vipps" : {
+ "description" : "Vipps details.",
+ "$ref" : "#/components/schemas/VippsInfo"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "required" : [
+ "type"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettings" : {
+ "properties" : {
+ "allowed" : {
+ "description" : "Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is:\n\n* **true** if `verificationStatus` is **valid**.\n* **false** for all other values.",
+ "type" : "boolean"
+ },
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ },
+ "enabledFromDate" : {
+ "description" : "The date when Adyen starts paying out to this bank account.\n\nFormat: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.\n\nIf not specified, the `enabled` field indicates if payouts are enabled for this bank account.\n\nIf a date is specified and:\n\n* `enabled`: **true**, payouts are enabled starting the specified date.\n* `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the payout setting.",
+ "type" : "string"
+ },
+ "priority" : {
+ "description" : "Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account.\n\n Possible values:\n* **first**: same day.\n* **urgent**: the next day.\n* **normal**: between 1 and 3 days.",
+ "enum" : [
+ "first",
+ "normal",
+ "urgent"
+ ],
+ "type" : "string"
+ },
+ "transferInstrumentId" : {
+ "description" : "The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.",
+ "type" : "string"
+ },
+ "verificationStatus" : {
+ "description" : "The status of the verification process for the bank account.\n\nPossible values:\n* **valid**: the verification was successful.\n* **pending**: the verification is in progress.\n* **invalid**: the information provided is not complete.\n* **rejected**: there are reasons to refuse working with this entity.",
+ "enum" : [
+ "invalid",
+ "pending",
+ "rejected",
+ "valid"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "transferInstrumentId",
+ "id"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettingsRequest" : {
+ "properties" : {
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ },
+ "enabledFromDate" : {
+ "description" : "The date when Adyen starts paying out to this bank account.\n\nFormat: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**.\n\nIf not specified, the `enabled` field indicates if payouts are enabled for this bank account.\n\nIf a date is specified and:\n\n* `enabled`: **true**, payouts are enabled starting the specified date.\n* `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**.",
+ "type" : "string"
+ },
+ "transferInstrumentId" : {
+ "description" : "The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "transferInstrumentId"
+ ],
+ "type" : "object"
+ },
+ "PayoutSettingsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The list of payout accounts.",
+ "items" : {
+ "$ref" : "#/components/schemas/PayoutSettings"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Profile" : {
+ "properties" : {
+ "authType" : {
+ "description" : "The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**.",
+ "type" : "string"
+ },
+ "autoWifi" : {
+ "description" : "Indicates whether to automatically select the best authentication method available. Does not work on older terminal models.",
+ "type" : "boolean"
+ },
+ "bssType" : {
+ "description" : "Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations.",
+ "type" : "string"
+ },
+ "channel" : {
+ "description" : "The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "defaultProfile" : {
+ "description" : "Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first.",
+ "type" : "boolean"
+ },
+ "eap" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast**",
+ "type" : "string"
+ },
+ "eapCaCert" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. The root certificate from the CA that signed the certificate of the RADIUS server that is part of your wireless network.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientCert" : {
+ "description" : "For `eap` **tls**. The certificate chain for the terminals. All terminals in the same network will use the same EAP client certificate.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientKey" : {
+ "description" : "For `eap` **tls**. The RSA private key for the client. Include the lines BEGIN RSA PRIVATE KEY and END RSA PRIVATE KEY.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapClientPwd" : {
+ "description" : "For `eap` **tls**. The password of the RSA key file, if that file is password-protected.",
+ "type" : "string"
+ },
+ "eapIdentity" : {
+ "description" : "For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server.",
+ "type" : "string"
+ },
+ "eapIntermediateCert" : {
+ "description" : "For `eap` **tls**. The EAP intermediate certificate.",
+ "$ref" : "#/components/schemas/File"
+ },
+ "eapPwd" : {
+ "description" : "For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server.",
+ "type" : "string"
+ },
+ "hiddenSsid" : {
+ "description" : "Indicates if the network doesn't broadcast its SSID. Mandatory for Android terminals, because these terminals rely on this setting to be able to connect to any network.",
+ "type" : "boolean"
+ },
+ "name" : {
+ "description" : "Your name for the Wi-Fi profile.",
+ "type" : "string"
+ },
+ "psk" : {
+ "description" : "For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network.",
+ "type" : "string"
+ },
+ "ssid" : {
+ "description" : "The name of the wireless network.",
+ "type" : "string"
+ },
+ "wsec" : {
+ "description" : "The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip**",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "ssid",
+ "bssType",
+ "authType",
+ "wsec"
+ ],
+ "type" : "object"
+ },
+ "ReceiptOptions" : {
+ "properties" : {
+ "logo" : {
+ "description" : "The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px.",
+ "maxLength" : 350000,
+ "type" : "string"
+ },
+ "qrCodeData" : {
+ "description" : "Data to print on the receipt as a QR code. This can include static text and the following variables:\n\n- `${merchantreference}`: the merchant reference of the transaction.\n- `${pspreference}`: the PSP reference of the transaction.\n\n For example, **http://www.example.com/order/${pspreference}/${merchantreference}**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ReceiptPrinting" : {
+ "properties" : {
+ "merchantApproved" : {
+ "description" : "Print a merchant receipt when the payment is approved.",
+ "type" : "boolean"
+ },
+ "merchantCancelled" : {
+ "description" : "Print a merchant receipt when the transaction is cancelled.",
+ "type" : "boolean"
+ },
+ "merchantCaptureApproved" : {
+ "description" : "Print a merchant receipt when capturing the payment is approved.",
+ "type" : "boolean"
+ },
+ "merchantCaptureRefused" : {
+ "description" : "Print a merchant receipt when capturing the payment is refused.",
+ "type" : "boolean"
+ },
+ "merchantRefundApproved" : {
+ "description" : "Print a merchant receipt when the refund is approved.",
+ "type" : "boolean"
+ },
+ "merchantRefundRefused" : {
+ "description" : "Print a merchant receipt when the refund is refused.",
+ "type" : "boolean"
+ },
+ "merchantRefused" : {
+ "description" : "Print a merchant receipt when the payment is refused.",
+ "type" : "boolean"
+ },
+ "merchantVoid" : {
+ "description" : "Print a merchant receipt when a previous transaction is voided.",
+ "type" : "boolean"
+ },
+ "shopperApproved" : {
+ "description" : "Print a shopper receipt when the payment is approved.",
+ "type" : "boolean"
+ },
+ "shopperCancelled" : {
+ "description" : "Print a shopper receipt when the transaction is cancelled.",
+ "type" : "boolean"
+ },
+ "shopperCaptureApproved" : {
+ "description" : "Print a shopper receipt when capturing the payment is approved.",
+ "type" : "boolean"
+ },
+ "shopperCaptureRefused" : {
+ "description" : "Print a shopper receipt when capturing the payment is refused.",
+ "type" : "boolean"
+ },
+ "shopperRefundApproved" : {
+ "description" : "Print a shopper receipt when the refund is approved.",
+ "type" : "boolean"
+ },
+ "shopperRefundRefused" : {
+ "description" : "Print a shopper receipt when the refund is refused.",
+ "type" : "boolean"
+ },
+ "shopperRefused" : {
+ "description" : "Print a shopper receipt when the payment is refused.",
+ "type" : "boolean"
+ },
+ "shopperVoid" : {
+ "description" : "Print a shopper receipt when a previous transaction is voided.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "ReleaseUpdateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "type" : {
+ "default" : "ReleaseUpdate",
+ "description" : "Type of terminal action: Update Release.",
+ "enum" : [
+ "ReleaseUpdate"
+ ],
+ "type" : "string"
+ },
+ "updateAtFirstMaintenanceCall" : {
+ "description" : "Boolean flag that tells if the terminal should update at the first next maintenance call. If false, terminal will update on its configured reboot time.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "RequestActivationResponse" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account you requested to activate.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "RestServiceError" : {
+ "properties" : {
+ "detail" : {
+ "description" : "A human-readable explanation specific to this occurrence of the problem.",
+ "type" : "string"
+ },
+ "errorCode" : {
+ "description" : "A code that identifies the problem type.",
+ "type" : "string"
+ },
+ "instance" : {
+ "description" : "A unique URI that identifies the specific occurrence of the problem.",
+ "type" : "string"
+ },
+ "invalidFields" : {
+ "description" : "Detailed explanation of each validation error, when applicable.",
+ "items" : {
+ "$ref" : "#/components/schemas/InvalidField"
+ },
+ "type" : "array"
+ },
+ "requestId" : {
+ "description" : "A unique reference for the request, essentially the same as `pspReference`.",
+ "type" : "string"
+ },
+ "response" : {
+ "description" : "JSON response payload.",
+ "$ref" : "#/components/schemas/JSONObject"
+ },
+ "status" : {
+ "description" : "The HTTP status code.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "title" : {
+ "description" : "A short, human-readable summary of the problem type.",
+ "type" : "string"
+ },
+ "type" : {
+ "description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "type",
+ "errorCode",
+ "title",
+ "detail",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "ScheduleTerminalActionsRequest" : {
+ "properties" : {
+ "actionDetails" : {
+ "description" : "Information about the action to take.",
+ "oneOf" : [
+ {
+ "$ref" : "#/components/schemas/InstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/InstallAndroidCertificateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/ReleaseUpdateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidCertificateDetails"
+ }
+ ]
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.",
+ "type" : "string"
+ },
+ "terminalIds" : {
+ "description" : "A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "ScheduleTerminalActionsResponse" : {
+ "properties" : {
+ "actionDetails" : {
+ "description" : "Information about the action to take.",
+ "oneOf" : [
+ {
+ "$ref" : "#/components/schemas/InstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/InstallAndroidCertificateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/ReleaseUpdateDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidAppDetails"
+ },
+ {
+ "$ref" : "#/components/schemas/UninstallAndroidCertificateDetails"
+ }
+ ]
+ },
+ "items" : {
+ "x-addedInVersion" : "1",
+ "description" : "A list containing a terminal ID and an action ID for each terminal that the action was scheduled for.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalActionScheduleDetail"
+ },
+ "type" : "array"
+ },
+ "scheduledAt" : {
+ "description" : "The date and time when the action should happen. \nFormat: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** \nThe action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. \nAn empty value causes the action to be sent as soon as possible: at the next maintenance call.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.",
+ "type" : "string"
+ },
+ "terminalsWithErrors" : {
+ "additionalProperties" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : "The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to.",
+ "type" : "object"
+ },
+ "totalErrors" : {
+ "description" : "The number of terminals for which scheduling the action failed.",
+ "format" : "int32",
+ "type" : "integer"
+ },
+ "totalScheduled" : {
+ "description" : "The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "Settings" : {
+ "properties" : {
+ "band" : {
+ "description" : "The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz.",
+ "type" : "string"
+ },
+ "roaming" : {
+ "description" : "Indicates whether roaming is enabled on the terminals.",
+ "type" : "boolean"
+ },
+ "timeout" : {
+ "description" : "The connection time-out in seconds. Minimum value: 0.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "ShippingLocation" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address details of the shipping location.",
+ "$ref" : "#/components/schemas/Address"
+ },
+ "contact" : {
+ "description" : "The contact details for the shipping location.",
+ "$ref" : "#/components/schemas/Contact"
+ },
+ "id" : {
+ "description" : "The unique identifier of the shipping location, for use as `shippingLocationId` when creating an order.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The unique name of the shipping location.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "ShippingLocationsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Physical locations where orders can be shipped to.",
+ "items" : {
+ "$ref" : "#/components/schemas/ShippingLocation"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Signature" : {
+ "properties" : {
+ "askSignatureOnScreen" : {
+ "description" : "If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**).",
+ "type" : "boolean"
+ },
+ "deviceName" : {
+ "description" : "Name that identifies the terminal.",
+ "type" : "string"
+ },
+ "deviceSlogan" : {
+ "description" : "Slogan shown on the start screen of the device.",
+ "maxLength" : 50,
+ "type" : "string"
+ },
+ "skipSignature" : {
+ "description" : "Skip asking for a signature. This is possible because all global card schemes (American Express, Diners, Discover, JCB, MasterCard, VISA, and UnionPay) regard a signature as optional.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "SofortInfo" : {
+ "properties" : {
+ "currencyCode" : {
+ "description" : "Sofort currency code. For example, **EUR**.",
+ "type" : "string"
+ },
+ "logo" : {
+ "description" : "Sofort logo. Format: Base64-encoded string.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo",
+ "currencyCode"
+ ],
+ "type" : "object"
+ },
+ "SplitConfiguration" : {
+ "properties" : {
+ "description" : {
+ "description" : "Your description for the split configuration.",
+ "maxLength" : 300,
+ "type" : "string"
+ },
+ "rules" : {
+ "description" : "Array of rules that define the split configuration behavior.",
+ "items" : {
+ "$ref" : "#/components/schemas/SplitConfigurationRule"
+ },
+ "type" : "array"
+ },
+ "splitConfigurationId" : {
+ "description" : "Unique identifier of the split configuration.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "stores" : {
+ "description" : "List of stores to which the split configuration applies.",
+ "items" : {
+ "type" : "string"
+ },
+ "readOnly" : true,
+ "type" : "array"
+ }
+ },
+ "required" : [
+ "description",
+ "rules"
+ ],
+ "type" : "object"
+ },
+ "SplitConfigurationList" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of split configurations applied to the stores under the merchant account.",
+ "items" : {
+ "$ref" : "#/components/schemas/SplitConfiguration"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "SplitConfigurationLogic" : {
+ "properties" : {
+ "acquiringFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "additionalCommission" : {
+ "description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
+ "$ref" : "#/components/schemas/AdditionalCommission"
+ },
+ "adyenCommission" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenMarkup" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "chargeback" : {
+ "description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount",
+ "deductAccordingToSplitRatio"
+ ],
+ "type" : "string"
+ },
+ "chargebackCostAllocation" : {
+ "description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "commission" : {
+ "description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
+ "$ref" : "#/components/schemas/Commission"
+ },
+ "interchange" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "paymentFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "remainder" : {
+ "description" : "Specifies the logic to apply when booking the amount left over after currency conversion.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "schemeFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "splitLogicId" : {
+ "description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "surcharge" : {
+ "description" : "Specifies the logic to apply when booking the surcharge amount.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "tip" : {
+ "description" : "Specifies the logic to apply when booking tips (gratuity).\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "commission"
+ ],
+ "type" : "object"
+ },
+ "SplitConfigurationRule" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
+ "type" : "string"
+ },
+ "fundingSource" : {
+ "description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.",
+ "enum" : [
+ "credit",
+ "debit",
+ "ANY"
+ ],
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method condition that defines whether the split logic applies.\n\nPossible values:\n* [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method.\n* **ANY**: Apply the split logic for all available payment methods.",
+ "type" : "string"
+ },
+ "ruleId" : {
+ "description" : "The unique identifier of the split configuration rule.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel condition that defines whether the split logic applies.\n\nPossible values:\n* **Ecommerce**: Online transactions where the cardholder is present.\n* **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).\n* **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.\n* **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.\n* **ANY**: All sales channels.",
+ "enum" : [
+ "Ecommerce",
+ "ContAuth",
+ "Moto",
+ "POS",
+ "ANY"
+ ],
+ "type" : "string"
+ },
+ "splitLogic" : {
+ "description" : "Contains the split logic that is applied if the rule conditions are met.",
+ "$ref" : "#/components/schemas/SplitConfigurationLogic"
+ }
+ },
+ "required" : [
+ "paymentMethod",
+ "shopperInteraction",
+ "currency",
+ "splitLogic"
+ ],
+ "type" : "object"
+ },
+ "Standalone" : {
+ "properties" : {
+ "currencyCode" : {
+ "description" : "The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
+ "maxLength" : 3,
+ "minLength" : 3,
+ "type" : "string"
+ },
+ "enableStandalone" : {
+ "description" : "Enable standalone mode.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "Store" : {
+ "properties" : {
+ "_links" : {
+ "description" : "Reference to resources connected with the store.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with.\n If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "The description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the store. This value is generated by Adyen.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account that the store belongs to.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "A reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name shown on the shopper's bank or credit card statement and on the shopper receipt.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platform merchants to [split commission fees](https://docs.adyen.com/marketplaces-and-platforms/classic/split-configuration-for-stores).",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ },
+ "status" : {
+ "description" : "The status of the store. Possible values are:\n\n- **active**. This value is assigned automatically when a store is created. \n- **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.\n- **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.",
+ "enum" : [
+ "active",
+ "closed",
+ "inactive"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "StoreCreationRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.\nIf not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).\n\nIf you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.\nMaximum length: 22 characters; can't be all numbers.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "The configuration of the split.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ }
+ },
+ "required" : [
+ "description",
+ "shopperStatement",
+ "phoneNumber",
+ "address"
+ ],
+ "type" : "object"
+ },
+ "StoreCreationWithMerchantCodeRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store.",
+ "$ref" : "#/components/schemas/StoreLocation"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with.\nIf not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Your description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account that the store belongs to.",
+ "type" : "string"
+ },
+ "phoneNumber" : {
+ "description" : "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
+ "type" : "string"
+ },
+ "reference" : {
+ "description" : "Your reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_).\n\nIf you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).",
+ "type" : "string"
+ },
+ "shopperStatement" : {
+ "description" : "The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt.\nMaximum length: 22 characters; can't be all numbers.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "The configuration of the split.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ }
+ },
+ "required" : [
+ "description",
+ "shopperStatement",
+ "phoneNumber",
+ "address",
+ "merchantId"
+ ],
+ "type" : "object"
+ },
+ "StoreLocation" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "country" : {
+ "description" : "The two-letter country code in [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.",
+ "type" : "string"
+ },
+ "line1" : {
+ "description" : "The street address.",
+ "type" : "string"
+ },
+ "line2" : {
+ "description" : "Second address line.",
+ "type" : "string"
+ },
+ "line3" : {
+ "description" : "Third address line.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "country"
+ ],
+ "type" : "object"
+ },
+ "StoreSplitConfiguration" : {
+ "properties" : {
+ "balanceAccountId" : {
+ "description" : "The [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) linked to the account holder.",
+ "type" : "string"
+ },
+ "splitConfigurationId" : {
+ "description" : "The UUID of the [split configuration](https://docs.adyen.com/marketplaces-and-platforms/classic/split-configuration-for-stores) from the Customer Area.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Surcharge" : {
+ "properties" : {
+ "askConfirmation" : {
+ "description" : "Show the surcharge details on the terminal, so the shopper can confirm.",
+ "type" : "boolean"
+ },
+ "configurations" : {
+ "description" : "Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies.",
+ "items" : {
+ "$ref" : "#/components/schemas/Configuration"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "SwishInfo" : {
+ "properties" : {
+ "swishNumber" : {
+ "description" : "Swish number. Format: 10 digits without spaces. For example, **1231111111**.",
+ "maxLength" : 10,
+ "minLength" : 10,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "swishNumber"
+ ],
+ "type" : "object"
+ },
+ "Terminal" : {
+ "properties" : {
+ "assignment" : {
+ "x-addedInVersion" : "2",
+ "description" : "Indicates the account level to which the terminal is assigned, the [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api), and where the terminals is in the process of being reassigned to.",
+ "$ref" : "#/components/schemas/TerminalAssignment"
+ },
+ "connectivity" : {
+ "x-addedInVersion" : "2",
+ "description" : "Information about bluetooth, cellular, ethernet and wifi connectivity for the terminal.",
+ "$ref" : "#/components/schemas/TerminalConnectivity"
+ },
+ "firmwareVersion" : {
+ "description" : "The software release currently in use on the terminal.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the terminal.",
+ "type" : "string"
+ },
+ "lastActivityAt" : {
+ "x-addedInVersion" : "2",
+ "description" : "Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "lastTransactionAt" : {
+ "x-addedInVersion" : "2",
+ "description" : "Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.",
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "model" : {
+ "x-addedInVersion" : "2",
+ "description" : "The model name of the terminal.",
+ "type" : "string"
+ },
+ "serialNumber" : {
+ "description" : "The serial number of the terminal.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalActionScheduleDetail" : {
+ "properties" : {
+ "id" : {
+ "description" : "The ID of the action on the specified terminal.",
+ "type" : "string"
+ },
+ "terminalId" : {
+ "description" : "The unique ID of the terminal that the action applies to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalAssignment" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which terminal is assigned.",
+ "type" : "string"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which terminal is assigned.",
+ "type" : "string"
+ },
+ "reassignmentTarget" : {
+ "description" : "Indicates where the terminal is in the process of being reassigned to.",
+ "$ref" : "#/components/schemas/TerminalReassignmentTarget"
+ },
+ "status" : {
+ "description" : "The status of the reassignment. Possible values: \n * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform.\n * `deployed`: the terminal is deployed and reassigned. \n * `inventory`: the terminal is in inventory and cannot process transactions. \n * `boarded`: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions. \n",
+ "enum" : [
+ "boarded",
+ "deployed",
+ "inventory",
+ "reassignmentInProgress"
+ ],
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which terminal is assigned.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "companyId",
+ "status"
+ ],
+ "type" : "object"
+ },
+ "TerminalConnectivity" : {
+ "properties" : {
+ "bluetooth" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityBluetooth"
+ },
+ "cellular" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityCellular"
+ },
+ "ethernet" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityEthernet"
+ },
+ "wifi" : {
+ "$ref" : "#/components/schemas/TerminalConnectivityWifi"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityBluetooth" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's Bluetooth IP address.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's Bluetooth MAC address.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityCellular" : {
+ "properties" : {
+ "iccid" : {
+ "description" : "The integrated circuit card identifier (ICCID) of the SIM card in the terminal.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal.",
+ "enum" : [
+ "activated",
+ "deactivated",
+ "deprecated",
+ "inventory",
+ "readyForActivation"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityEthernet" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's ethernet IP address.",
+ "type" : "string"
+ },
+ "linkNegotiation" : {
+ "description" : "The ethernet link negotiation that the terminal uses.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's ethernet MAC address.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalConnectivityWifi" : {
+ "properties" : {
+ "ipAddress" : {
+ "description" : "The terminal's IP address in the Wi-Fi network.",
+ "type" : "string"
+ },
+ "macAddress" : {
+ "description" : "The terminal's MAC address in the Wi-Fi network.",
+ "type" : "string"
+ },
+ "ssid" : {
+ "description" : "The SSID of the Wi-Fi network that the terminal is connected to.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalModelsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "The terminal models that the API credential has access to.",
+ "items" : {
+ "$ref" : "#/components/schemas/IdName"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrder" : {
+ "properties" : {
+ "billingEntity" : {
+ "description" : "The details of the entity that the order is billed to.",
+ "$ref" : "#/components/schemas/BillingEntity"
+ },
+ "customerOrderReference" : {
+ "description" : "The merchant-defined purchase order number. This will be printed on the packing list.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the order.",
+ "type" : "string"
+ },
+ "items" : {
+ "description" : "The products included in the order.",
+ "items" : {
+ "$ref" : "#/components/schemas/OrderItem"
+ },
+ "type" : "array"
+ },
+ "orderDate" : {
+ "description" : "The date and time that the order was placed, in UTC ISO 8601 format. For example, \"2011-12-03T10:15:30Z\".",
+ "type" : "string"
+ },
+ "shippingLocation" : {
+ "description" : "The details of the location where the order is shipped to.",
+ "$ref" : "#/components/schemas/ShippingLocation"
+ },
+ "status" : {
+ "description" : "The processing status of the order.",
+ "type" : "string"
+ },
+ "trackingUrl" : {
+ "description" : "The URL, provided by the carrier company, where the shipment can be tracked.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrderRequest" : {
+ "properties" : {
+ "billingEntityId" : {
+ "description" : "The identification of the billing entity to use for the order.",
+ "type" : "string"
+ },
+ "customerOrderReference" : {
+ "description" : "The merchant-defined purchase order reference.",
+ "type" : "string"
+ },
+ "items" : {
+ "description" : "The products included in the order.",
+ "items" : {
+ "$ref" : "#/components/schemas/OrderItem"
+ },
+ "type" : "array"
+ },
+ "orderType" : {
+ "description" : "Type of order",
+ "type" : "string"
+ },
+ "shippingLocationId" : {
+ "description" : "The identification of the shipping location to use for the order.",
+ "type" : "string"
+ },
+ "taxId" : {
+ "description" : "The tax number of the billing entity.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalOrdersResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List of orders for payment terminal packages and parts.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalOrder"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProduct" : {
+ "properties" : {
+ "description" : {
+ "description" : "Information about items included and integration options.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the product.",
+ "type" : "string"
+ },
+ "itemsIncluded" : {
+ "description" : "A list of parts included in the terminal package.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "name" : {
+ "description" : "The descriptive name of the product.",
+ "type" : "string"
+ },
+ "price" : {
+ "description" : "The price of the product.",
+ "$ref" : "#/components/schemas/TerminalProductPrice"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProductPrice" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The price of the item.",
+ "format" : "double",
+ "type" : "number"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalProductsResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "Terminal products that can be ordered.",
+ "items" : {
+ "$ref" : "#/components/schemas/TerminalProduct"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalReassignmentRequest" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "inventory" : {
+ "description" : "Must be specified when reassigning terminals to a merchant account:\n\n- If set to **true**, reassigns terminals to the inventory of the merchant account and the terminals cannot process transactions.\n\n- If set to **false**, reassigns terminals directly to the merchant account and the terminals can process transactions.",
+ "type" : "boolean"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which the terminal is reassigned. When reassigning terminals to a merchant account, you must specify the `inventory` field.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which the terminal is reassigned.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TerminalReassignmentTarget" : {
+ "properties" : {
+ "companyId" : {
+ "description" : "The unique identifier of the company account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "inventory" : {
+ "description" : "Indicates if the terminal is reassigned to the inventory of the merchant account.\n- If **true**, the terminal is in the inventory of the merchant account and cannot process transactions.\n- If **false**, the terminal is reassigned directly to the merchant account and can process transactions.",
+ "type" : "boolean"
+ },
+ "merchantId" : {
+ "description" : "The unique identifier of the merchant account to which the terminal is reassigned.",
+ "type" : "string"
+ },
+ "storeId" : {
+ "description" : "The unique identifier of the store to which the terminal is reassigned.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "inventory"
+ ],
+ "type" : "object"
+ },
+ "TerminalSettings" : {
+ "properties" : {
+ "cardholderReceipt" : {
+ "description" : "Settings to define the header of the shopper receipt.",
+ "$ref" : "#/components/schemas/CardholderReceipt"
+ },
+ "connectivity" : {
+ "description" : "Settings for terminal connectivity features.",
+ "$ref" : "#/components/schemas/Connectivity"
+ },
+ "gratuities" : {
+ "description" : "Settings for tipping with or without predefined options to choose from. The maximum number of predefined options is four, or three plus the option to enter a custom tip.",
+ "items" : {
+ "$ref" : "#/components/schemas/Gratuity"
+ },
+ "type" : "array"
+ },
+ "hardware" : {
+ "description" : "Settings for terminal hardware features.",
+ "$ref" : "#/components/schemas/Hardware"
+ },
+ "localization" : {
+ "description" : "Settings for localization.",
+ "$ref" : "#/components/schemas/Localization"
+ },
+ "nexo" : {
+ "description" : "Settings for a Terminal API integration.",
+ "$ref" : "#/components/schemas/Nexo"
+ },
+ "offlineProcessing" : {
+ "description" : "Settings for [offline payment](https://docs.adyen.com/point-of-sale/offline-payments) features.",
+ "$ref" : "#/components/schemas/OfflineProcessing"
+ },
+ "opi" : {
+ "description" : "Settings for an Oracle Payment Interface (OPI) integration.",
+ "$ref" : "#/components/schemas/Opi"
+ },
+ "passcodes" : {
+ "description" : "Settings for [passcodes](https://docs.adyen.com/point-of-sale/managing-terminals/menu-access?tab=manage_passcodes_with_an_api_call_2#manage-passcodes) features.",
+ "$ref" : "#/components/schemas/Passcodes"
+ },
+ "payAtTable" : {
+ "description" : "Settings for [Pay-at-table](https://docs.adyen.com/point-of-sale/pay-at-x) features.",
+ "$ref" : "#/components/schemas/PayAtTable"
+ },
+ "payment" : {
+ "description" : "Settings for payment features.",
+ "$ref" : "#/components/schemas/Payment"
+ },
+ "receiptOptions" : {
+ "description" : "Generic receipt settings.",
+ "$ref" : "#/components/schemas/ReceiptOptions"
+ },
+ "receiptPrinting" : {
+ "description" : "Transaction outcomes that you want the terminal to print a merchant receipt or a shopper receipt for.",
+ "$ref" : "#/components/schemas/ReceiptPrinting"
+ },
+ "signature" : {
+ "description" : "Settings to skip signature, sign on display, or sign on receipt.",
+ "$ref" : "#/components/schemas/Signature"
+ },
+ "standalone" : {
+ "description" : "Settings for [standalone](https://docs.adyen.com/point-of-sale/standalone/standalone-build/set-up-standalone#set-up-standalone-using-an-api-call) features.",
+ "$ref" : "#/components/schemas/Standalone"
+ },
+ "surcharge" : {
+ "description" : "Settings for payment [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.",
+ "$ref" : "#/components/schemas/Surcharge"
+ },
+ "timeouts" : {
+ "description" : "Settings for device [time-outs](https://docs.adyen.com/point-of-sale/pos-timeouts#device-time-out).",
+ "$ref" : "#/components/schemas/Timeouts"
+ },
+ "wifiProfiles" : {
+ "description" : "Remote Wi-Fi profiles for WPA and WPA2 PSK and EAP Wi-Fi networks.",
+ "$ref" : "#/components/schemas/WifiProfiles"
+ }
+ },
+ "type" : "object"
+ },
+ "TestCompanyWebhookRequest" : {
+ "properties" : {
+ "merchantIds" : {
+ "description" : "List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values.\n\nIf not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "notification" : {
+ "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.",
+ "$ref" : "#/components/schemas/CustomNotification"
+ },
+ "types" : {
+ "description" : "List of event codes for which to send test notifications. Only the webhook types below are supported. \n\nPossible values if webhook `type`: **standard**:\n\n* **AUTHORISATION**\n* **CHARGEBACK_REVERSED**\n* **ORDER_CLOSED**\n* **ORDER_OPENED**\n* **PAIDOUT_REVERSED**\n* **PAYOUT_THIRDPARTY**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**\n* **REPORT_AVAILABLE**\n* **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.\n\nPossible values if webhook `type`: **banktransfer-notification**:\n\n* **PENDING**\n\nPossible values if webhook `type`: **report-notification**:\n\n* **REPORT_AVAILABLE**\n\nPossible values if webhook `type`: **ideal-notification**:\n\n* **AUTHORISATION**\n\nPossible values if webhook `type`: **pending-notification**:\n\n* **PENDING**\n",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TestOutput" : {
+ "properties" : {
+ "merchantId" : {
+ "description" : "Unique identifier of the merchant account that the notification is about.",
+ "type" : "string"
+ },
+ "output" : {
+ "description" : "The response your server returned for the test webhook.\n\nYour server must respond with **[accepted]** for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications)\n\nYou can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks.",
+ "type" : "string"
+ },
+ "requestSent" : {
+ "description" : "The [body of the notification webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#notification-structure) that was sent to your server.",
+ "type" : "string"
+ },
+ "responseCode" : {
+ "description" : "The HTTP response code for your server's response to the test webhook.\n\nYou can use the value of this field together with the the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field value to troubleshoot failed test webhooks.",
+ "example" : "200",
+ "type" : "string"
+ },
+ "responseTime" : {
+ "description" : "The time between sending the test webhook and receiving the response from your server. You can use it as an indication of how long your server takes to process a webhook notification. Measured in milliseconds, for example **304 ms**.",
+ "type" : "string"
+ },
+ "status" : {
+ "description" : "The status of the test request. Possible values are:\n* **success**, if `data.output`: **[accepted]** and `data.responseCode`: **200**.\n* **failed**, in all other cases.\n\nYou can use the value of the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot failed test webhooks.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "status"
+ ],
+ "type" : "object"
+ },
+ "TestWebhookRequest" : {
+ "properties" : {
+ "notification" : {
+ "description" : "Custom test notification object. Required when the [`types`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_types) list contains **CUSTOM**.",
+ "$ref" : "#/components/schemas/CustomNotification"
+ },
+ "types" : {
+ "description" : "List of event codes for which to send test notifications. Only the webhook types below are supported. \n\nPossible values if webhook `type`: **standard**:\n\n* **AUTHORISATION**\n* **CHARGEBACK_REVERSED**\n* **ORDER_CLOSED**\n* **ORDER_OPENED**\n* **PAIDOUT_REVERSED**\n* **PAYOUT_THIRDPARTY**\n* **REFUNDED_REVERSED**\n* **REFUND_WITH_DATA**\n* **REPORT_AVAILABLE**\n* **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object.\n\nPossible values if webhook `type`: **banktransfer-notification**:\n\n* **PENDING**\n\nPossible values if webhook `type`: **report-notification**:\n\n* **REPORT_AVAILABLE**\n\nPossible values if webhook `type`: **ideal-notification**:\n\n* **AUTHORISATION**\n\nPossible values if webhook `type`: **pending-notification**:\n\n* **PENDING**\n",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "TestWebhookResponse" : {
+ "properties" : {
+ "data" : {
+ "description" : "List with test results. Each test webhook we send has a list element with the result.",
+ "items" : {
+ "$ref" : "#/components/schemas/TestOutput"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "Timeouts" : {
+ "properties" : {
+ "fromActiveToSleep" : {
+ "description" : "Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode.",
+ "format" : "int32",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "TransactionDescriptionInfo" : {
+ "properties" : {
+ "doingBusinessAsName" : {
+ "description" : "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.",
+ "maxLength" : 22,
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "dynamic",
+ "description" : "The type of transaction description you want to use:\n- **fixed**: The transaction description set in this request is used for all payments with this payment method.\n- **append**: The transaction description set in this request is used as a base for all payments with this payment method. The [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string.\n- **dynamic**: Only the [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method.",
+ "enum" : [
+ "append",
+ "dynamic",
+ "fixed"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "TwintInfo" : {
+ "properties" : {
+ "logo" : {
+ "description" : "Twint logo. Format: Base64-encoded string.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo"
+ ],
+ "type" : "object"
+ },
+ "UninstallAndroidAppDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "appId" : {
+ "description" : "The unique identifier of the app to be uninstalled.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "UninstallAndroidApp",
+ "description" : "Type of terminal action: Uninstall an Android app.",
+ "enum" : [
+ "UninstallAndroidApp"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UninstallAndroidCertificateDetails" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "certificateId" : {
+ "description" : "The unique identifier of the certificate to be uninstalled.",
+ "type" : "string"
+ },
+ "type" : {
+ "default" : "UninstallAndroidCertificate",
+ "description" : "Type of terminal action: Uninstall an Android certificate.",
+ "enum" : [
+ "UninstallAndroidCertificate"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatableAddress" : {
+ "properties" : {
+ "city" : {
+ "description" : "The name of the city.",
+ "type" : "string"
+ },
+ "line1" : {
+ "description" : "The street address.",
+ "type" : "string"
+ },
+ "line2" : {
+ "description" : "Second address line.",
+ "type" : "string"
+ },
+ "line3" : {
+ "description" : "Third address line.",
+ "type" : "string"
+ },
+ "postalCode" : {
+ "description" : "The postal code.",
+ "type" : "string"
+ },
+ "stateOrProvince" : {
+ "description" : "The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada.\n\nRequired for the following countries:\n - Australia\n- Brazil\n- Canada\n- India\n- Mexico\n- New Zealand\n- United States",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyApiCredentialRequest" : {
+ "properties" : {
+ "active" : {
+ "description" : "Indicates if the API credential is enabled.",
+ "type" : "boolean"
+ },
+ "allowedOrigins" : {
+ "description" : "The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "List of merchant accounts that the API credential has access to.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "associatedMerchantAccounts" : {
+ "description" : "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) to associate the user with.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name2"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateCompanyWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are filtered when configuring the webhook. Possible values:\n* **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`.\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantApiCredentialRequest" : {
+ "properties" : {
+ "active" : {
+ "description" : "Indicates if the API credential is enabled.",
+ "type" : "boolean"
+ },
+ "allowedOrigins" : {
+ "description" : "The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "Description of the API credential.",
+ "type" : "string"
+ },
+ "roles" : {
+ "description" : "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantUserRequest" : {
+ "properties" : {
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Sets the status of the user to active (**true**) or inactive (**false**).",
+ "type" : "boolean"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "maxLength" : 80,
+ "minLength" : 1,
+ "$ref" : "#/components/schemas/Name2"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateMerchantWebhookRequest" : {
+ "properties" : {
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettings"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "password" : {
+ "description" : "Password to access the webhook URL.",
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "maxLength" : 255,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatePaymentMethodInfo" : {
+ "properties" : {
+ "bcmc" : {
+ "description" : "Bancontact details.",
+ "$ref" : "#/components/schemas/BcmcInfo"
+ },
+ "cartesBancaires" : {
+ "description" : "Cartes Bancaires details.",
+ "$ref" : "#/components/schemas/CartesBancairesInfo"
+ },
+ "countries" : {
+ "description" : "The list of countries where a payment method is available. By default, all countries supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "cup" : {
+ "description" : "China Union Pay details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "currencies" : {
+ "description" : "The list of currencies that a payment method supports. By default, all currencies supported by the payment method.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "diners" : {
+ "description" : "Diners details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "discover" : {
+ "description" : "Discover details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "eftpos_australia" : {
+ "description" : "Eftpos Australia details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "enabled" : {
+ "description" : "Indicates whether the payment method is enabled (**true**) or disabled (**false**).",
+ "type" : "boolean"
+ },
+ "girocard" : {
+ "description" : "Girocard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "ideal" : {
+ "description" : "iDeal details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "interac_card" : {
+ "description" : "Interac Card details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "jcb" : {
+ "description" : "JCB details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "maestro" : {
+ "description" : "Maestro details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "mc" : {
+ "description" : "MasterCard details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ },
+ "storeIds" : {
+ "description" : "The list of stores for this payment method",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "visa" : {
+ "description" : "Visa details.",
+ "$ref" : "#/components/schemas/GenericPmWithTdiInfo"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdatePayoutSettingsRequest" : {
+ "properties" : {
+ "enabled" : {
+ "description" : "Indicates if payouts to this bank account are enabled. Default: **true**.\n\nTo receive payouts into this bank account, both `enabled` and `allowed` must be **true**.",
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationLogicRequest" : {
+ "properties" : {
+ "acquiringFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "additionalCommission" : {
+ "description" : "Contains the logic used to calculate your user's commission, booked directly to their balance account.",
+ "$ref" : "#/components/schemas/AdditionalCommission"
+ },
+ "adyenCommission" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenFees" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "adyenMarkup" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "chargeback" : {
+ "description" : "Specifies the logic to apply when booking the chargeback amount.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount",
+ "deductAccordingToSplitRatio"
+ ],
+ "type" : "string"
+ },
+ "chargebackCostAllocation" : {
+ "description" : "Specifies the logic to apply when allocating the chargeback costs.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "commission" : {
+ "description" : "Contains the logic used to the calculate your platform's commission, booked to your liable balance account.",
+ "$ref" : "#/components/schemas/Commission"
+ },
+ "interchange" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "paymentFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "remainder" : {
+ "description" : "Specifies the logic to apply when booking the amount left over after currency conversion.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "schemeFee" : {
+ "description" : "Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**.",
+ "enum" : [
+ "deductFromLiableAccount",
+ "deductFromOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "splitLogicId" : {
+ "description" : "Unique identifier of the split logic that is applied when the split configuration conditions are met.",
+ "readOnly" : true,
+ "type" : "string"
+ },
+ "surcharge" : {
+ "description" : "Specifies the logic to apply when booking the surcharge amount.\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ },
+ "tip" : {
+ "description" : "Specifies the logic to apply when booking tips (gratuity).\n\nPossible values: **addToLiableAccount**, **addToOneBalanceAccount**.",
+ "enum" : [
+ "addToLiableAccount",
+ "addToOneBalanceAccount"
+ ],
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "commission"
+ ],
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationRequest" : {
+ "properties" : {
+ "description" : {
+ "description" : "Your description for the split configuration.",
+ "maxLength" : 300,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "description"
+ ],
+ "type" : "object"
+ },
+ "UpdateSplitConfigurationRuleRequest" : {
+ "properties" : {
+ "currency" : {
+ "description" : "The currency condition that defines whether the split logic applies.\nIts value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
+ "type" : "string"
+ },
+ "fundingSource" : {
+ "description" : "The funding source condition of the payment method (only for cards).\n\nPossible values: **credit**, **debit**, or **ANY**.",
+ "type" : "string"
+ },
+ "paymentMethod" : {
+ "description" : "The payment method condition that defines whether the split logic applies.\n\nPossible values:\n* [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method.\n* **ANY**: Apply the split logic for all available payment methods.",
+ "type" : "string"
+ },
+ "shopperInteraction" : {
+ "description" : "The sales channel condition that defines whether the split logic applies.\n\nPossible values:\n* **Ecommerce**: Online transactions where the cardholder is present.\n* **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).\n* **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.\n* **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.\n* **ANY**: All sales channels.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "paymentMethod",
+ "shopperInteraction",
+ "currency"
+ ],
+ "type" : "object"
+ },
+ "UpdateStoreRequest" : {
+ "properties" : {
+ "address" : {
+ "description" : "The address of the store. It is not possible to update the country of the store.",
+ "$ref" : "#/components/schemas/UpdatableAddress"
+ },
+ "businessLineIds" : {
+ "description" : "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "description" : "The description of the store.",
+ "type" : "string"
+ },
+ "externalReferenceId" : {
+ "description" : "When using the Zip payment method: The location ID that Zip has assigned to your store.",
+ "type" : "string"
+ },
+ "splitConfiguration" : {
+ "description" : "Rules for Adyen for Platform merchants to split commission fees.",
+ "$ref" : "#/components/schemas/StoreSplitConfiguration"
+ },
+ "status" : {
+ "description" : "The status of the store. Possible values are:\n\n- **active**: This value is assigned automatically when a store is created. \n- **inactive**: The maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible.\n- **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.\n\nYou can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**. \nOnce **closed**, a store can't be reopened.",
+ "enum" : [
+ "active",
+ "closed",
+ "inactive"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "UploadAndroidAppResponse" : {
+ "properties" : {
+ "id" : {
+ "description" : "The unique identifier of the uploaded Android app.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "Url" : {
+ "properties" : {
+ "encrypted" : {
+ "description" : "Indicates if the message sent to this URL should be encrypted.",
+ "type" : "boolean"
+ },
+ "password" : {
+ "description" : "The password for authentication of the notifications.",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "The URL in the format: http(s)://domain.com.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for authentication of the notifications.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "User" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this user.",
+ "$ref" : "#/components/schemas/Links"
+ },
+ "accountGroups" : {
+ "description" : "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "active" : {
+ "description" : "Indicates whether this user is active.",
+ "type" : "boolean"
+ },
+ "apps" : {
+ "description" : "Set of apps available to this user",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "email" : {
+ "description" : "The email address of the user.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "The unique identifier of the user.",
+ "type" : "string"
+ },
+ "name" : {
+ "description" : "The user's full name.",
+ "$ref" : "#/components/schemas/Name"
+ },
+ "roles" : {
+ "description" : "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "timeZoneCode" : {
+ "description" : "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "The username for this user.",
+ "maxLength" : 255,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "id",
+ "email",
+ "timeZoneCode",
+ "username",
+ "roles"
+ ],
+ "type" : "object"
+ },
+ "VippsInfo" : {
+ "properties" : {
+ "logo" : {
+ "description" : "Vipps logo. Format: Base64-encoded string.",
+ "type" : "string"
+ },
+ "subscriptionCancelUrl" : {
+ "description" : "Vipps subscription cancel url (required in case of [recurring payments](https://docs.adyen.com/online-payments/tokenization))",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "logo"
+ ],
+ "type" : "object"
+ },
+ "Void" : {
+ "type" : "object"
+ },
+ "Webhook" : {
+ "properties" : {
+ "_links" : {
+ "description" : "References to resources connected with this webhook.",
+ "$ref" : "#/components/schemas/WebhookLinks"
+ },
+ "acceptsExpiredCertificate" : {
+ "description" : "Indicates if expired SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsSelfSignedCertificate" : {
+ "description" : "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "acceptsUntrustedRootCertificate" : {
+ "description" : "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
+ "type" : "boolean"
+ },
+ "accountReference" : {
+ "description" : "Reference to the account the webook is set on.",
+ "type" : "string"
+ },
+ "active" : {
+ "description" : "Indicates if the webhook configuration is active. The field must be **true** for you to receive webhooks about events related an account.",
+ "type" : "boolean"
+ },
+ "additionalSettings" : {
+ "description" : "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
+ "$ref" : "#/components/schemas/AdditionalSettingsResponse"
+ },
+ "certificateAlias" : {
+ "description" : "The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.",
+ "type" : "string"
+ },
+ "communicationFormat" : {
+ "description" : "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
+ "enum" : [
+ "http",
+ "json",
+ "soap"
+ ],
+ "example" : "soap",
+ "type" : "string"
+ },
+ "description" : {
+ "description" : "Your description for this webhook configuration.",
+ "type" : "string"
+ },
+ "encryptionProtocol" : {
+ "x-addedInVersion" : "2",
+ "description" : "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
+ "enum" : [
+ "HTTP",
+ "TLSv1.2",
+ "TLSv1.3"
+ ],
+ "example" : "TLSv1.2",
+ "type" : "string"
+ },
+ "filterMerchantAccountType" : {
+ "description" : "Shows how merchant accounts are included in company-level webhooks. Possible values:\n* **includeAccounts**\n* **excludeAccounts**\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
+ "enum" : [
+ "allAccounts",
+ "excludeAccounts",
+ "includeAccounts"
+ ],
+ "type" : "string"
+ },
+ "filterMerchantAccounts" : {
+ "description" : "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "hasError" : {
+ "description" : "Indicates if the webhook configuration has errors that need troubleshooting. If the value is **true**, troubleshoot the configuration using the [testing endpoint](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookid}/test).",
+ "type" : "boolean"
+ },
+ "hasPassword" : {
+ "description" : "Indicates if the webhook is password protected.",
+ "type" : "boolean"
+ },
+ "hmacKeyCheckValue" : {
+ "description" : "The [checksum](https://en.wikipedia.org/wiki/Key_checksum_value) of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Unique identifier for this webhook.",
+ "type" : "string"
+ },
+ "networkType" : {
+ "description" : "Network type for Terminal API details webhooks.",
+ "enum" : [
+ "local",
+ "public"
+ ],
+ "type" : "string"
+ },
+ "populateSoapActionHeader" : {
+ "description" : "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
+ "type" : "boolean"
+ },
+ "type" : {
+ "description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
+ "type" : "string"
+ },
+ "url" : {
+ "description" : "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
+ "example" : "http://www.adyen.com",
+ "type" : "string"
+ },
+ "username" : {
+ "description" : "Username to access the webhook URL.",
+ "type" : "string"
+ }
+ },
+ "required" : [
+ "type",
+ "url",
+ "active",
+ "communicationFormat"
+ ],
+ "type" : "object"
+ },
+ "WebhookLinks" : {
+ "properties" : {
+ "company" : {
+ "description" : "The company account that the webhook is configured for. Only present for company-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "generateHmac" : {
+ "description" : "Generate an HMAC key.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "merchant" : {
+ "description" : "The merchant account that the webhook is configured for. Only present for merchant-level webhooks.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "self" : {
+ "description" : "Link to the resource itself.",
+ "$ref" : "#/components/schemas/LinksElement"
+ },
+ "testWebhook" : {
+ "description" : "Test the webhook setup.",
+ "$ref" : "#/components/schemas/LinksElement"
+ }
+ },
+ "required" : [
+ "self",
+ "testWebhook",
+ "generateHmac"
+ ],
+ "type" : "object"
+ },
+ "WifiProfiles" : {
+ "properties" : {
+ "profiles" : {
+ "description" : "List of remote Wi-Fi profiles.",
+ "items" : {
+ "$ref" : "#/components/schemas/Profile"
+ },
+ "type" : "array"
+ },
+ "settings" : {
+ "description" : "General Wi-Fi settings.",
+ "$ref" : "#/components/schemas/Settings"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "securitySchemes" : {
+ "ApiKeyAuth" : {
+ "in" : "header",
+ "name" : "X-API-Key",
+ "type" : "apiKey"
+ },
+ "BasicAuth" : {
+ "scheme" : "basic",
+ "type" : "http"
+ }
+ },
+ "examples" : {
+ "get-companies-companyId-androidApps-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of Android apps",
+ "value" : {
+ "data" : [
+ {
+ "id" : "ANDA422LZ223223K5F694GCCF732K8",
+ "packageName" : "com.your_company.posapp",
+ "versionCode" : 7700203,
+ "description" : "POS2",
+ "label" : "POS system",
+ "versionName" : "7.7",
+ "status" : "ready"
+ },
+ {
+ "id" : "ANDA422LZ223223K5F694FWCF738PL",
+ "packageName" : "com.your_company.posapp",
+ "versionCode" : 7602003,
+ "description" : "POS1",
+ "label" : "POS system",
+ "versionName" : "7.6",
+ "status" : "ready"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-androidCertificates-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of Android certificates",
+ "value" : {
+ "data" : [
+ {
+ "id" : "ANDC422LZ223223K5F78NVN9SL4VPH",
+ "name" : "mycert",
+ "extension" : ".crt",
+ "description" : "",
+ "status" : "ready",
+ "notBefore" : "2008-04-20T00:00:00+02:00",
+ "notAfter" : "2038-04-12T00:00:00+02:00"
+ },
+ {
+ "id" : "ANDC533MA33433L689OWO0TM5WQI",
+ "name" : "mynewcert",
+ "extension" : ".pem",
+ "description" : "",
+ "status" : "ready",
+ "notBefore" : "2008-04-20T00:00:00+02:00",
+ "notAfter" : "2048-04-12T00:00:00+02:00"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origins-200" : {
+ "summary" : "OK 200 - Get the list of allowed origins for the API credential",
+ "description" : "Example response for getting the list of allowed origins for the API credential.",
+ "value" : {
+ "data" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origin-200" : {
+ "summary" : "OK 200 - Get an allowed origin for the API credential",
+ "description" : "Example response for getting an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "get-companies-companyId-apiCredentials-apiCredentialId-success-200" : {
+ "summary" : "Details of the API credential",
+ "description" : "Example response with details of the API credential at the company level",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "http://localhost",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "http://localhost:3000",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ },
+ "get-companies-companyId-apiCredentials-success-200" : {
+ "summary" : "List of API credentials",
+ "description" : "Example response when your API credential has access to 25 API credentials at the company level",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 25,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_API_CREDENTIAL_1",
+ "username" : "YOUR_USERNAME_1",
+ "clientKey" : "YOUR_CLIENT_KEY_1",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "http://localhost",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "http://localhost:3000",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_1/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_2",
+ "username" : "YOUR_USERNAME_2",
+ "clientKey" : "YOUR_CLIENT_KEY_2",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_3",
+ "username" : "YOUR_USERNAME_3",
+ "clientKey" : "YOUR_CLIENT_KEY_3",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "API Supply MPI data with Payments",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "API 3DS 2.0 to retrieve the ThreeDS2Result for authentication only"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_4",
+ "username" : "YOUR_USERNAME_4",
+ "clientKey" : "YOUR_CLIENT_KEY_4",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_1"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_5",
+ "username" : "YOUR_USERNAME_5",
+ "clientKey" : "YOUR_CLIENT_KEY_5",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API Authorise Referred Payments",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_6",
+ "username" : "YOUR_USERNAME_6",
+ "clientKey" : "YOUR_CLIENT_KEY_6",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_7",
+ "username" : "YOUR_USERNAME_7",
+ "clientKey" : "YOUR_CLIENT_KEY_7",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_2",
+ "YOUR_MERCHANT_ACCOUNT_3"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_8",
+ "username" : "YOUR_USERNAME_8",
+ "clientKey" : "YOUR_CLIENT_KEY_8",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_9",
+ "username" : "YOUR_USERNAME_9",
+ "clientKey" : "YOUR_CLIENT_KEY_9",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_4",
+ "YOUR_MERCHANT_ACCOUNT_5"
+ ]
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_10",
+ "username" : "YOUR_USERNAME_10",
+ "clientKey" : "YOUR_CLIENT_KEY_10",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-billingEntities-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with billing entities for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-merchants-success-200" : {
+ "summary" : "List of merchant accounts",
+ "description" : "Example response when your API credential has access to 22 merchant accounts",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/merchants?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 22,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_1",
+ "name" : "YOUR_MERCHANT_NAME_1",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_1",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_2",
+ "name" : "YOUR_MERCHANT_NAME_2",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "POS",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_2",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_3",
+ "status" : "Active",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_4",
+ "name" : "YOUR_MERCHANT_NAME_4",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_4",
+ "merchantCity" : "Sao Paulo",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_5",
+ "name" : "YOUR_MERCHANT_NAME_5",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_5",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_6",
+ "name" : "YOUR_MERCHANT_NAME_6",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_6",
+ "merchantCity" : "Zagreb",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_6/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_7",
+ "name" : "YOUR_MERCHANT_NAME_7",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Moto",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_7",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_8",
+ "name" : "YOUR_MERCHANT_NAME_8",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_8",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_9",
+ "name" : "YOUR_MERCHANT_NAME_9",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_9",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_10",
+ "name" : "YOUR_MERCHANT_NAME_10",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_10",
+ "merchantCity" : "Paris",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-shippingLocations-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with shipping locations for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-success-200" : {
+ "summary" : "Details of the company account",
+ "description" : "Example response with the details of the company account.",
+ "value" : {
+ "id" : "YOUR_COMPANY_ACCOUNT",
+ "name" : "YOUR_SHOP_NAME",
+ "status" : "Active",
+ "dataCenters" : [
+ {
+ "name" : "default",
+ "livePrefix" : ""
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"
+ }
+ }
+ }
+ },
+ "get-companies-companyId-terminalActions-actionId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the specified terminal action",
+ "value" : {
+ "actionType" : "InstallAndroidCertificate",
+ "config" : "{\"certificates\":\"5dff6b...\"}",
+ "confirmedAt" : "2022-06-27T17:44:54+02:00",
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "result" : "Ok",
+ "scheduledAt" : "2022-06-27T15:44:07+02:00",
+ "status" : "successful",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ },
+ "get-companies-companyId-terminalActions-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of scheduled terminal actions",
+ "value" : {
+ "data" : [
+ {
+ "actionType" : "InstallAndroidApp",
+ "config" : "{\"apps\":\"com.adyen.android.calculator:103\"}",
+ "confirmedAt" : "2021-11-10T00:00:00+01:00",
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "result" : "Cancelled manually by user USER@Psp.AdyenPspService",
+ "scheduledAt" : "2021-11-10T14:53:05+01:00",
+ "status" : "cancelled",
+ "terminalId" : "S1E-000150183300032"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-companies-companyId-terminalModels-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal models that the company has access to",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Verifone.e315",
+ "name" : "Verifone e315"
+ },
+ {
+ "id" : "Verifone.e315M",
+ "name" : "Verifone e315M"
+ },
+ {
+ "id" : "Verifone.E355",
+ "name" : "Verifone E355"
+ },
+ {
+ "id" : "Verifone.M400",
+ "name" : "Verifone M400"
+ },
+ {
+ "id" : "Verifone.MX915",
+ "name" : "Verifone MX915"
+ },
+ {
+ "id" : "Verifone.MX925",
+ "name" : "Verifone MX925"
+ },
+ {
+ "id" : "Verifone.P400",
+ "name" : "Verifone P400"
+ },
+ {
+ "id" : "Verifone.P400Plus",
+ "name" : "Verifone P400Plus"
+ },
+ {
+ "id" : "Verifone.P400Eth",
+ "name" : "Verifone P400Eth"
+ },
+ {
+ "id" : "Verifone.V240m",
+ "name" : "Verifone V240m"
+ },
+ {
+ "id" : "Verifone.V240mPlus",
+ "name" : "Verifone V240mPlus"
+ },
+ {
+ "id" : "Verifone.UX300",
+ "name" : "Verifone UX300"
+ },
+ {
+ "id" : "Verifone.V200cPlus",
+ "name" : "Verifone V200cPlus"
+ },
+ {
+ "id" : "Verifone.V400cPlus",
+ "name" : "Verifone V400cPlus"
+ },
+ {
+ "id" : "Verifone.V400m",
+ "name" : "Verifone V400m"
+ },
+ {
+ "id" : "Verifone.V210mPlus",
+ "name" : "Verifone V210mPlus"
+ },
+ {
+ "id" : "Verifone.VX520",
+ "name" : "Verifone VX520"
+ },
+ {
+ "id" : "Verifone.VX6753G",
+ "name" : "Verifone VX6753G"
+ },
+ {
+ "id" : "Verifone.VX675WIFIBT",
+ "name" : "Verifone VX675WIFIBT"
+ },
+ {
+ "id" : "Verifone.VX680",
+ "name" : "Verifone VX680"
+ },
+ {
+ "id" : "Verifone.VX6803G",
+ "name" : "Verifone VX6803G"
+ },
+ {
+ "id" : "Verifone.VX690",
+ "name" : "Verifone VX690"
+ },
+ {
+ "id" : "Verifone.VX700",
+ "name" : "Verifone VX700"
+ },
+ {
+ "id" : "Verifone.VX810",
+ "name" : "Verifone VX810"
+ },
+ {
+ "id" : "Verifone.VX820",
+ "name" : "Verifone VX820"
+ },
+ {
+ "id" : "Verifone.VX825",
+ "name" : "Verifone VX825"
+ },
+ {
+ "id" : "Verifone.e285",
+ "name" : "Verifone e285"
+ },
+ {
+ "id" : "Verifone.E285",
+ "name" : "Verifone E285"
+ },
+ {
+ "id" : "Verifone.e285p",
+ "name" : "Verifone e285p"
+ },
+ {
+ "id" : "Verifone.e280",
+ "name" : "Verifone e280"
+ },
+ {
+ "id" : "Verifone.UX410",
+ "name" : "Verifone UX410"
+ },
+ {
+ "id" : "Castles.S1E",
+ "name" : "Castles S1E"
+ },
+ {
+ "id" : "Castles.S1EL",
+ "name" : "Castles S1EL"
+ },
+ {
+ "id" : "Castles.S1F",
+ "name" : "Castles S1F"
+ },
+ {
+ "id" : "Castles.S1F2",
+ "name" : "Castles S1F2"
+ },
+ {
+ "id" : "Castles.S1F2L",
+ "name" : "Castles S1F2L"
+ },
+ {
+ "id" : "Castles.S1E2",
+ "name" : "Castles S1E2"
+ },
+ {
+ "id" : "Castles.S1E2L",
+ "name" : "Castles S1E2L"
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalOrders-orderId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the terminal products order",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_1",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalOrders-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal orders for a company",
+ "value" : {
+ "data" : [
+ {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_C2",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2020-06-10T17:03:11.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-MX925-422-EU",
+ "name" : "MX925 Package",
+ "quantity" : 1
+ }
+ ]
+ },
+ {
+ "id" : "9415936144678634",
+ "customerOrderReference" : "YOUR_REFERENCE_C1",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-03T16:41:07.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-774-EU",
+ "name" : "V400m Package",
+ "quantity" : 5
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalProducts-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with V400m products available in The Netherlands",
+ "value" : {
+ "data" : [
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-327486-EU",
+ "name" : "Battery - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-745984-EU",
+ "name" : "Power Supply EU - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "description" : "Includes an EU Power Supply, SIM Card and battery",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ },
+ "itemsIncluded" : [
+ "Receipt Roll",
+ "Terminal Device V400m EU/GB"
+ ]
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-companies-companyId-webhooks-get-company-webhooks-200" : {
+ "summary" : "OK 200 - Get the list of webhook configurations",
+ "description" : "Example response for getting the list of webhook configurations.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "adyen",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-companies-companyId-webhooks-webhookId-get-company-webhook-200" : {
+ "summary" : "OK 200 - Get a webhook configuration",
+ "description" : "Example response for getting a webhook configuration.",
+ "value" : {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "adyen",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ },
+ "get-companies-success-200" : {
+ "summary" : "List of company accounts",
+ "description" : "Example response when your API credential has access to one company account.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "YOUR_COMPANY_ACCOUNT",
+ "name" : "YOUR_COMPANY_NAME",
+ "status" : "Active",
+ "dataCenters" : [
+ {
+ "name" : "default",
+ "livePrefix" : ""
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-get-allowed-origin-200" : {
+ "summary" : "OK 200 - Get the list of allowed origins for the API credential",
+ "description" : "Example response for getting the list of allowed origins for the API credential.",
+ "value" : {
+ "data" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "https://www.us.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-originId-get-allowed-origins-200" : {
+ "summary" : "OK 200 - Get an allowed origin for the API credential",
+ "description" : "Example response for getting an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-apiCredentialId-success-200" : {
+ "summary" : "Details of the API credential",
+ "description" : "Example response with details of the API credential at the merchant level",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-apiCredentials-success-200" : {
+ "summary" : "List of API credentials at the merchant level",
+ "description" : "Example response when your API credential has access to 11 API credentials at the merchant level",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 11,
+ "pagesTotal" : 2,
+ "data" : [
+ {
+ "id" : "YOUR_API_CREDENTIAL_1",
+ "username" : "YOUR_USERNAME_1",
+ "clientKey" : "YOUR_CLIENT_KEY_1",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Report Download role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_CREDENTIAL_1/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_2",
+ "username" : "YOUR_USERNAME_2",
+ "clientKey" : "YOUR_CLIENT_KEY_2",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant Rss feed role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_2/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_3",
+ "username" : "YOUR_USERNAME_3",
+ "clientKey" : "YOUR_CLIENT_KEY_3",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant iDeal-API Webservice role",
+ "Management API - Accounts read",
+ "Management API - API credentials read and write",
+ "Management API — Payment methods read",
+ "Merchant PAL Donation role",
+ "Merchant PAL Charity role",
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role",
+ "Store payout detail and submit payout - withdrawal",
+ "Management API - Accounts read and write",
+ "Management API - Webhooks read",
+ "Merchant Payout role",
+ "API tokenise payment details",
+ "General API Payments role",
+ "API Supply MPI data with Payments",
+ "API Authorise Referred Payments",
+ "API PCI Payments role",
+ "CSC Tokenization Webservice role",
+ "Management API - Stores read",
+ "API Payment RefundWithData",
+ "API Clientside Encryption Payments role",
+ "API to retrieve authentication data",
+ "Management API - Stores read and write",
+ "Management API - Webhooks read and write",
+ "Mastercard inControl service",
+ "Merchant Recurring role",
+ "Management API - Payout Account Settings Read",
+ "API surcharge cost estimation and regulatory information",
+ "Store payout detail",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_1",
+ "domain" : "YOUR_DOMAIN_1",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins/YOUR_ALLOWED_ORIGIN_1"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN_2",
+ "domain" : "YOUR_DOMAIN_2",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins/YOUR_ALLOWED_ORIGIN_2"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_3/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_4",
+ "username" : "YOUR_USERNAME_4",
+ "clientKey" : "YOUR_CLIENT_KEY_4",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "API Clientside Encryption Payments role",
+ "API tokenise payment details",
+ "General API Payments role",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "CSC Tokenization Webservice role",
+ "Checkout webservice role",
+ "ThreeDSecure WebService Role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_4/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_5",
+ "username" : "YOUR_USERNAME_5",
+ "clientKey" : "YOUR_CLIENT_KEY_5",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Merchant iDeal-API Webservice role",
+ "General API Payments role",
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_5/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_6",
+ "username" : "YOUR_USERNAME_6",
+ "clientKey" : "YOUR_CLIENT_KEY_6",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_6/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_7",
+ "username" : "YOUR_USERNAME_7",
+ "clientKey" : "YOUR_CLIENT_KEY_7",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_7/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_8",
+ "username" : "YOUR_USERNAME_8",
+ "clientKey" : "YOUR_CLIENT_KEY_8",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_8/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_9",
+ "username" : "YOUR_USERNAME_9",
+ "clientKey" : "YOUR_CLIENT_KEY_9",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "API PCI Payments role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_9/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_API_CREDENTIAL_10",
+ "username" : "YOUR_USERNAME_10",
+ "clientKey" : "YOUR_CLIENT_KEY_10",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout encrypted cardholder data",
+ "Merchant Recurring role",
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL_10/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-billingEntities-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with billing entities for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-shippingLocations-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with shipping locations for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-splitConfigurations-splitConfigurationId-success-200" : {
+ "summary" : "Details of the split configuration",
+ "description" : "Example response with details of the split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "get-merchants-merchantId-splitConfigurations-success-200" : {
+ "summary" : "List of split configurations",
+ "description" : "Example response when retrieving the list of split configurations in your merchant account",
+ "value" : {
+ "data" : [
+ {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "GBP",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HP89PPCST6BCZ",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 200,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HP89PPCSV27VP",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HP89PPCSS24MF"
+ },
+ {
+ "description" : "Your description for the second split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-stores-reference-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-merchants-merchantId-stores-reference-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "receiptOptions" : {
+
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-merchants-merchantId-stores-storeId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the details of a store",
+ "value" : {
+ "storeId" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-stores-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of stores for a merchant account",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ }
+ },
+ "itemsTotal" : 2,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ },
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL6",
+ "address" : {
+ "city" : "North Madison",
+ "country" : "US",
+ "line1" : "1492 Townline Road",
+ "line2" : "Rowland Business Park",
+ "postalCode" : "20577",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "West location",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1211992213193020",
+ "reference" : "Second Madison store",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-success-200" : {
+ "summary" : "Details of the merchant account",
+ "description" : "Example response with details of the merchant account",
+ "value" : {
+ "id" : "YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_NAME",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks"
+ }
+ }
+ }
+ },
+ "get-merchants-merchantId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-merchants-merchantId-terminalModels-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal models that the merchant account has access to",
+ "value" : {
+ "data" : [
+ {
+ "id" : "Verifone.e315",
+ "name" : "Verifone e315"
+ },
+ {
+ "id" : "Verifone.e315M",
+ "name" : "Verifone e315M"
+ },
+ {
+ "id" : "Verifone.E355",
+ "name" : "Verifone E355"
+ },
+ {
+ "id" : "Verifone.M400",
+ "name" : "Verifone M400"
+ },
+ {
+ "id" : "Verifone.MX915",
+ "name" : "Verifone MX915"
+ },
+ {
+ "id" : "Verifone.MX925",
+ "name" : "Verifone MX925"
+ },
+ {
+ "id" : "Verifone.P400",
+ "name" : "Verifone P400"
+ },
+ {
+ "id" : "Verifone.P400Plus",
+ "name" : "Verifone P400Plus"
+ },
+ {
+ "id" : "Verifone.P400Eth",
+ "name" : "Verifone P400Eth"
+ },
+ {
+ "id" : "Verifone.V240m",
+ "name" : "Verifone V240m"
+ },
+ {
+ "id" : "Verifone.V240mPlus",
+ "name" : "Verifone V240mPlus"
+ },
+ {
+ "id" : "Verifone.UX300",
+ "name" : "Verifone UX300"
+ },
+ {
+ "id" : "Verifone.V200cPlus",
+ "name" : "Verifone V200cPlus"
+ },
+ {
+ "id" : "Verifone.V400cPlus",
+ "name" : "Verifone V400cPlus"
+ },
+ {
+ "id" : "Verifone.V400m",
+ "name" : "Verifone V400m"
+ },
+ {
+ "id" : "Verifone.V210mPlus",
+ "name" : "Verifone V210mPlus"
+ },
+ {
+ "id" : "Verifone.VX520",
+ "name" : "Verifone VX520"
+ },
+ {
+ "id" : "Verifone.VX6753G",
+ "name" : "Verifone VX6753G"
+ },
+ {
+ "id" : "Verifone.VX675WIFIBT",
+ "name" : "Verifone VX675WIFIBT"
+ },
+ {
+ "id" : "Verifone.VX680",
+ "name" : "Verifone VX680"
+ },
+ {
+ "id" : "Verifone.VX6803G",
+ "name" : "Verifone VX6803G"
+ },
+ {
+ "id" : "Verifone.VX690",
+ "name" : "Verifone VX690"
+ },
+ {
+ "id" : "Verifone.VX700",
+ "name" : "Verifone VX700"
+ },
+ {
+ "id" : "Verifone.VX810",
+ "name" : "Verifone VX810"
+ },
+ {
+ "id" : "Verifone.VX820",
+ "name" : "Verifone VX820"
+ },
+ {
+ "id" : "Verifone.VX825",
+ "name" : "Verifone VX825"
+ },
+ {
+ "id" : "Verifone.e285",
+ "name" : "Verifone e285"
+ },
+ {
+ "id" : "Verifone.E285",
+ "name" : "Verifone E285"
+ },
+ {
+ "id" : "Verifone.e285p",
+ "name" : "Verifone e285p"
+ },
+ {
+ "id" : "Verifone.e280",
+ "name" : "Verifone e280"
+ },
+ {
+ "id" : "Verifone.UX410",
+ "name" : "Verifone UX410"
+ },
+ {
+ "id" : "Castles.S1E",
+ "name" : "Castles S1E"
+ },
+ {
+ "id" : "Castles.S1EL",
+ "name" : "Castles S1EL"
+ },
+ {
+ "id" : "Castles.S1F",
+ "name" : "Castles S1F"
+ },
+ {
+ "id" : "Castles.S1F2",
+ "name" : "Castles S1F2"
+ },
+ {
+ "id" : "Castles.S1F2L",
+ "name" : "Castles S1F2L"
+ },
+ {
+ "id" : "Castles.S1E2",
+ "name" : "Castles S1E2"
+ },
+ {
+ "id" : "Castles.S1E2L",
+ "name" : "Castles S1E2L"
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalOrders-orderId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the details of the terminal products order",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalOrders-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with the terminal orders for a merchant account",
+ "value" : {
+ "data" : [
+ {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE_M2",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ },
+ {
+ "id" : "8315943674501996",
+ "customerOrderReference" : "YOUR_REFERENCE_M1",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-04T09:41:07.000Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-774-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalProducts-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response with V400m products available in Spain",
+ "value" : {
+ "data" : [
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-327486-EU",
+ "name" : "Battery - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "PART-745984-EU",
+ "name" : "Power Supply EU - V400m",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ }
+ },
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "description" : "Includes an EU Power Supply, SIM Card and battery",
+ "price" : {
+ "currency" : "EUR",
+ "value" : 0.00
+ },
+ "itemsIncluded" : [
+ "Receipt Roll",
+ "Terminal Device V400m EU/GB"
+ ]
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-merchants-merchantId-webhooks-get-merchant-webhooks-200" : {
+ "summary" : "OK 200 - Get the list of webhook configurations",
+ "description" : "Example response for getting the list of webhook configurations.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-merchants-merchantId-webhooks-webhookId-get-merchant-webhook-200" : {
+ "summary" : "OK 200 - Get a webhook configuration",
+ "description" : "Example response for getting a webhook configuration.",
+ "value" : {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ },
+ "get-merchants-success-200" : {
+ "summary" : "List of merchant accounts",
+ "description" : "Example response when your API credential has access to 23 merchant accounts",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=3&pageSize=10"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=2&pageSize=10"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants?pageNumber=1&pageSize=10"
+ }
+ },
+ "itemsTotal" : 23,
+ "pagesTotal" : 3,
+ "data" : [
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_1",
+ "name" : "YOUR_MERCHANT_NAME_1",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_1",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_1/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_2",
+ "name" : "YOUR_MERCHANT_NAME_2",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "POS",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_2",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_2/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_3",
+ "status" : "YOUR_MERCHANT_NAME_3",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_3/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_4",
+ "name" : "YOUR_MERCHANT_NAME_4",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_4",
+ "merchantCity" : "Sao Paulo",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_4/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_5",
+ "name" : "YOUR_MERCHANT_NAME_5",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_5",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_5/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_6",
+ "name" : "YOUR_MERCHANT_NAME_6",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_6",
+ "merchantCity" : "Zagreb",
+ "primarySettlementCurrency" : "BRL",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_NAME_6/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_7",
+ "name" : "YOUR_MERCHANT_NAME_7",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Moto",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_7",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_7/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_8",
+ "name" : "YOUR_MERCHANT_NAME_8",
+ "captureDelay" : "immediate",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_8",
+ "merchantCity" : "Amsterdam",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_8/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_9",
+ "name" : "YOUR_MERCHANT_NAME_9",
+ "captureDelay" : "3",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_9",
+ "merchantCity" : "",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_9/webhooks"
+ }
+ }
+ },
+ {
+ "id" : "YOUR_MERCHANT_ACCOUNT_10",
+ "name" : "YOUR_MERCHANT_NAME_10",
+ "captureDelay" : "manual",
+ "defaultShopperInteraction" : "Ecommerce",
+ "status" : "Active",
+ "shopWebAddress" : "YOUR_SHOP_URL_10",
+ "merchantCity" : "Paris",
+ "primarySettlementCurrency" : "EUR",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10"
+ },
+ "apiCredentials" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/apiCredentials"
+ },
+ "users" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/users"
+ },
+ "webhooks" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_10/webhooks"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-stores-storeId-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the details of a store",
+ "value" : {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ }
+ },
+ "get-stores-storeId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-stores-storeId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "get-stores-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting a list of stores",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"
+ }
+ },
+ "itemsTotal" : 2,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL5",
+ "address" : {
+ "city" : "Springfield",
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "postalCode" : "20250",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Springfield Shop",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"
+ }
+ }
+ },
+ {
+ "id" : "ST322LJ223223K5F4SQNR9XL6",
+ "address" : {
+ "city" : "North Madison",
+ "country" : "US",
+ "line1" : "1492 Townline Road",
+ "line2" : "Rowland Business Park",
+ "postalCode" : "20577",
+ "stateOrProvince" : "NY"
+ },
+ "description" : "West location",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "phoneNumber" : "+1211992213193020",
+ "reference" : "Second Madison store",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-terminals-success-200" : {
+ "summary" : "List of terminals",
+ "description" : "Example response when getting terminals that your API credential has access to.",
+ "value" : {
+ "_links" : {
+ "first" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "last" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "next" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"
+ },
+ "self" : {
+ "href" : "https://management-test.adyen.com/v3/terminals?pageNumber=0&pageSize=20"
+ }
+ },
+ "itemsTotal" : 1,
+ "pagesTotal" : 1,
+ "data" : [
+ {
+ "id" : "AMS1-000150183300032",
+ "model" : "AMS1",
+ "serialNumber" : "000150183300032",
+ "firmwareVersion" : "Castles_Android 1.89.4",
+ "assignment" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT",
+ "storeId" : "YOUR_STORE_ID",
+ "status" : "reassignmentInProgress",
+ "reassignmentTarget" : {
+ "inventory" : true
+ }
+ },
+ "connectivity" : {
+ "cellular" : {
+ "iccid" : "6006491286999921374"
+ },
+ "wifi" : {
+ "ipAddress" : "198.51.100.1",
+ "macAddress" : "C4:6E:33:26:36:E4"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "get-terminals-terminalId-terminalLogos-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the logo of a payment terminal",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING"
+ }
+ },
+ "get-terminals-terminalId-terminalSettings-success-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response when getting the settings of a payment terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "hiddenSsid" : false,
+ "name" : "Guest Wi-Fi",
+ "psk" : "4R8R2R3V456X",
+ "ssid" : "G470P37660D4G",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "All",
+ "roaming" : true
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential" : {
+ "summary" : "Activate an API credential",
+ "description" : "Example request for activating an API credential.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-companies-companyId-apiCredentials-apiCredentialId-patch-company-credential-200" : {
+ "summary" : "OK 200 - Activate an API credential",
+ "description" : "Example response for activating an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Management API - Accounts read",
+ "Management API - Webhooks read",
+ "Management API - API credentials read and write",
+ "Management API - Stores read",
+ "Management API — Payment methods read",
+ "Management API - Stores read and write",
+ "Management API - Webhooks read and write",
+ "Merchant Recurring role",
+ "Data Protection API",
+ "Management API - Payout Account Settings Read",
+ "Checkout webservice role",
+ "Management API - Accounts read and write",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-companies-companyId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-companies-companyId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-companies-companyId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-companies-companyId-terminalOrders-orderId-update-order" : {
+ "summary" : "Update a terminal order",
+ "description" : "Example request to update an order for terminal products",
+ "value" : {
+ "shippingLocation" : "S2-7973536B20662642215526704F302044452F714622375D476169",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 5
+ }
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalOrders-orderId-update-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE_1",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-7973536B20662642215526704F302044452F714622375D476169",
+ "name" : "YOUR_COMPANY Rokin depot",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : "",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 5
+ }
+ ]
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-companies-companyId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-companies-companyId-webhooks-webhookId-patch-company-webhook" : {
+ "summary" : "Activate the webhook",
+ "description" : "Example request for activating a webhook configuration.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-companies-companyId-webhooks-webhookId-patch-company-webhook-200" : {
+ "summary" : "OK 200 - Activate the webhook",
+ "description" : "Example response for activating a webhook configuration.",
+ "value" : {
+ "id" : "S2-4A3B33202A46",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "allAccounts",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/test"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential" : {
+ "summary" : "Activate an API credential",
+ "description" : "Example request for activating an API credential.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-merchants-merchantId-apiCredentials-apiCredentialId-patch-merchant-credential-200" : {
+ "summary" : "OK 200 - Activate an API credential",
+ "description" : "Example response for activating an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role",
+ "Merchant PAL Webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description" : {
+ "summary" : "Update split configuration description",
+ "description" : "Example request for updating the description of a split configuration",
+ "value" : {
+ "description" : "Updated description for the split configuration"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-patch-splitConfiguration-description-200" : {
+ "summary" : "Split configuration description updated",
+ "description" : "Example response after updating the description of a split configuration",
+ "value" : {
+ "description" : "Updated description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule" : {
+ "summary" : "Update the conditions in split configuration rule",
+ "description" : "Example request for updating the conditions of a rule in a split configuration",
+ "value" : {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "shopperInteraction" : "ANY"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-patch-splitConfiguration-rule-200" : {
+ "summary" : "Split configuration rule updated",
+ "description" : "Example response after updating a rule in a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic" : {
+ "summary" : "Update the split logic",
+ "description" : "Example request for updating the split logic in a split configuration rule",
+ "value" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ },
+ "patch-merchants-merchantId-splitConfigurations-splitConfigurationId-rules-ruleId-splitLogic-splitLogicId-patch-splitConfiguration-rule-splitLogic-200" : {
+ "summary" : "Split logic updated",
+ "description" : "Example response after updating the split logic",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "EUR",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 0,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 100,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToLiableAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-reference-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores" : {
+ "summary" : "Update store address.",
+ "description" : "Example request to update the address of a store",
+ "value" : {
+ "address" : {
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "postalCode" : "20251"
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating the store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration" : {
+ "summary" : "Add split configuration to store",
+ "description" : "Example request to add a split configuration to the store",
+ "value" : {
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ }
+ },
+ "patch-merchants-merchantId-stores-storeId-patch-stores-splitConfiguration-200" : {
+ "summary" : "Split configuration added to store",
+ "description" : "Example response after adding a split confuguration to the store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ },
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-merchants-merchantId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-merchants-merchantId-terminalOrders-orderId-update-order" : {
+ "summary" : "Update a terminal order",
+ "description" : "Example request to update an order for terminal products",
+ "value" : {
+ "shippingLocation" : "S2-73536B20665526704F30792642212044452F714622375D477270",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "patch-merchants-merchantId-terminalOrders-orderId-update-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-73536B20665526704F30792642212044452F714622375D477270",
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34931234567",
+ "email" : "Rita.Perengano@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : "",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-merchants-merchantId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "nexoEventUrls" : [
+ "https://your-event-notifications-endpoint.com"
+ ]
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook" : {
+ "summary" : "Activate the webhook",
+ "description" : "Example request for activating a webhook configuration.",
+ "value" : {
+ "active" : true
+ }
+ },
+ "patch-merchants-merchantId-webhooks-webhookId-patch-merchant-webhook-200" : {
+ "summary" : "OK 200 - Activate the webhook",
+ "description" : "Example response for activating a webhook configuration.",
+ "value" : {
+ "id" : "S2-3E5E42476641",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "",
+ "hasPassword" : false,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : false,
+ "acceptsUntrustedRootCertificate" : false,
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test"
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores" : {
+ "summary" : "Update store address.",
+ "description" : "Example request to update the address of a store",
+ "value" : {
+ "address" : {
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "postalCode" : "20251"
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after updating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "1776 West Pinewood Avenue",
+ "line2" : "Heartland Building",
+ "line3" : "",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20251"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-patch-stores-splitConfiguration" : {
+ "summary" : "Add split configuration to store",
+ "description" : "Example request to add a split configuration to the store",
+ "value" : {
+ "splitConfiguration" : {
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH",
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ }
+ },
+ "patch-stores-storeId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-stores-storeId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-stores-storeId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-stores-storeId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-stores-storeId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-remove-logo" : {
+ "summary" : "Remove logo to restore the logo from a higher level",
+ "description" : "Example request to remove the payment terminal logo configured at the current level, and inherit the logo from a higher level",
+ "value" : {
+ "data" : ""
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-remove-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for removing a payment terminal logo to restore the logo from a higher level",
+ "value" : {
+ "data" : "LOGO_INHERITED_FROM_HIGHER_LEVEL_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-upload-logo" : {
+ "summary" : "Upload terminal logo",
+ "description" : "Example request to upload a payment terminal logo",
+ "value" : {
+ "data" : "LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING"
+ }
+ },
+ "patch-terminals-terminalId-terminalLogos-upload-logo-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for uploading a payment terminal logo",
+ "value" : {
+ "data" : "BASE-64_ENCODED_STRING_FROM_THE_REQUEST"
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles" : {
+ "summary" : "Add EAP-PEAP and PSK Wi-Fi profiles",
+ "description" : "Example request to add an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-peap-and-psk-wifi-profiles-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-PEAP Wi-Fi profile and a PSK Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "peap",
+ "eapCaCert" : {
+ "data" : "MD1rKS05M2JqRVFNQ...RTtLH1tLWo=",
+ "name" : "eap-peap-ca.pem"
+ },
+ "eapIdentity" : "admin",
+ "eapIntermediateCert" : {
+ "data" : "PD3tUS1CRDdJTiGDR...EFoLS0tLQg=",
+ "name" : "eap-peap-client.pem"
+ },
+ "eapPwd" : "EAP_PEAP_PASSWORD",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-peap-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ },
+ {
+ "authType" : "wpa-psk",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : false,
+ "hiddenSsid" : false,
+ "name" : "Profile-guest-wifi",
+ "psk" : "WIFI_PASSWORD",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile" : {
+ "summary" : "Add EAP-TLS Wi-Fi profile",
+ "description" : "Example request to add an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ }
+ }
+ },
+ "patch-terminals-terminalId-terminalSettings-add-eap-tls-wifi-profile-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response for adding an EAP-TLS Wi-Fi profile for a terminal",
+ "value" : {
+ "cardholderReceipt" : {
+ "headerForAuthorizedReceipt" : "header1,header2,filler"
+ },
+ "gratuities" : [
+ {
+ "currency" : "EUR",
+ "usePredefinedTipEntries" : true,
+ "predefinedTipEntries" : [
+ "100",
+ "1%",
+ "5%"
+ ],
+ "allowCustomAmount" : true
+ }
+ ],
+ "nexo" : {
+ "displayUrls" : {
+ "localUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-display-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "encryptionKey" : {
+ "identifier" : "KEY_IDENTIFIER",
+ "passphrase" : "KEY_PASSPHRASE",
+ "version" : 1
+ },
+ "eventUrls" : {
+ "eventPublicUrls" : [
+ {
+ "password" : "BASIC_AUTH_PASSWORD",
+ "url" : "https://your-event-notifications-endpoint.com",
+ "username" : "BASIC_AUTH_USERNAME"
+ }
+ ]
+ },
+ "notification" : {
+ "showButton" : true
+ }
+ },
+ "opi" : {
+ "enablePayAtTable" : true,
+ "payAtTableStoreNumber" : "1",
+ "payAtTableURL" : "https:/your-pay-at-table-endpoint.com"
+ },
+ "offlineProcessing" : {
+ "chipFloorLimit" : 0
+ },
+ "receiptOptions" : {
+ "qrCodeData" : "http://www.example.com/order/${pspreference}/${merchantreference}"
+ },
+ "receiptPrinting" : {
+ "shopperApproved" : true,
+ "shopperRefused" : true,
+ "shopperCancelled" : true,
+ "shopperRefundApproved" : true,
+ "shopperRefundRefused" : true,
+ "shopperVoid" : true
+ },
+ "signature" : {
+ "askSignatureOnScreen" : true,
+ "skipSignature" : false,
+ "deviceName" : "Amsterdam-236203386"
+ },
+ "wifiProfiles" : {
+ "profiles" : [
+ {
+ "authType" : "wpa-eap",
+ "autoWifi" : false,
+ "bssType" : "infra",
+ "channel" : 0,
+ "defaultProfile" : true,
+ "eap" : "tls",
+ "eapCaCert" : {
+ "data" : "LS0tLS05M2JqRVFNQ...EUtLS0tLQo=",
+ "name" : "eap-tls-ca.pem"
+ },
+ "eapClientCert" : {
+ "data" : "LS0tLS1CRUdJTiBDR...EUtLS0tLQo=",
+ "name" : "eap-tls-client.pem"
+ },
+ "eapClientKey" : {
+ "data" : "AAAB3NzaC1...Rtah3KLFwPU=",
+ "name" : "rsa-private.key"
+ },
+ "eapClientPwd" : "",
+ "eapIdentity" : "admin",
+ "hiddenSsid" : false,
+ "name" : "Profile-eap-tls-1",
+ "ssid" : "your-network",
+ "wsec" : "ccmp"
+ }
+ ],
+ "settings" : {
+ "band" : "2.4GHz",
+ "roaming" : true,
+ "timeout" : 5
+ }
+ },
+ "timeouts" : {
+ "fromActiveToSleep" : 30
+ },
+ "hardware" : {
+ "displayMaximumBackLight" : 75,
+ "restartHour" : 5
+ },
+ "passcodes" : {
+ "adminMenuPin" : "1234",
+ "txMenuPin" : "1234",
+ "refundPin" : "123456",
+ "screenLockPin" : "1111"
+ },
+ "connectivity" : {
+ "simcardStatus" : "INVENTORY"
+ }
+ }
+ },
+ "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin" : {
+ "summary" : "Add an allowed origin for the API credential",
+ "description" : "Example request for adding an allowed origin for the API credential.",
+ "value" : {
+ "domain" : "https://www.eu.mystore.com"
+ }
+ },
+ "post-companies-companyId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200" : {
+ "summary" : "OK 200 - Add an allowed origin for the API credential",
+ "description" : "Example response for adding an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "post-companies-companyId-apiCredentials-post-company-credential" : {
+ "summary" : "Add an API credential",
+ "description" : "Example request for adding an API credential.",
+ "value" : {
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "allowedOrigins" : [
+ "https://www.mystore.com"
+ ],
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_AU",
+ "YOUR_MERCHANT_ACCOUNT_EU",
+ "YOUR_MERCHANT_ACCOUNT_US"
+ ]
+ }
+ },
+ "post-companies-companyId-apiCredentials-post-company-credential-200" : {
+ "summary" : "OK 200 - Add an API credential",
+ "description" : "Example response for adding an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ }
+ },
+ "apiKey" : "YOUR_API_KEY",
+ "password" : "YOUR_PASSWORD",
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT_AU",
+ "YOUR_MERCHANT_ACCOUNT_EU",
+ "YOUR_MERCHANT_ACCOUNT_US"
+ ]
+ }
+ },
+ "post-companies-companyId-shippingLocations-create-shipping-location" : {
+ "summary" : "Create a shipping location",
+ "description" : "Example request to create a shipping location",
+ "value" : {
+ "name" : "YOUR_COMPANY Rokin depot",
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : "",
+ "country" : "NL"
+ },
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ }
+ }
+ },
+ "post-companies-companyId-shippingLocations-create-shipping-location-200" : {
+ "summary" : "Shipping location created",
+ "description" : "Example response after creating a shipping location",
+ "value" : {
+ "id" : "S2-7973536B20662642215526704F302044452F714622375D476169",
+ "name" : "YOUR_COMPANY Rokin depot",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "phoneNumber" : "+31 020 1234567",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "Rokin 21",
+ "postalCode" : "1012 KS",
+ "city" : "Amsterdam",
+ "stateOrProvince" : ""
+ }
+ }
+ },
+ "post-companies-companyId-terminalOrders-create-order" : {
+ "summary" : "Create an order",
+ "description" : "Example request to create an order for terminal products",
+ "value" : {
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "shippingLocationId" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "billingEntityId" : "Company.YOUR_COMPANY",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-terminalOrders-create-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "NL"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-terminalOrders-orderId-cancel-cancel-order-200" : {
+ "summary" : "Terminal order cancelled",
+ "description" : "Example response after cancelling an order for terminal products",
+ "value" : {
+ "id" : "5265677890100681",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-232A6D2967356F424F4369432B3F486B6A6D",
+ "name" : "YOUR_COMPANY HQ - POS Ops",
+ "contact" : {
+ "firstName" : "Paul",
+ "lastName" : "Green",
+ "email" : "Paul.Green@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat",
+ "streetAddress2" : "6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "Netherlands"
+ }
+ },
+ "billingEntity" : {
+ "id" : "Company.YOUR_COMPANY",
+ "name" : "YOUR_COMPANY",
+ "taxId" : "NL1234567890",
+ "email" : "Paul.Green@company.com",
+ "address" : {
+ "streetAddress" : "Simon Carmiggeltstraat 6-50",
+ "postalCode" : "1011 DJ",
+ "city" : "Amsterdam",
+ "country" : "Netherlands"
+ }
+ },
+ "orderDate" : "2022-01-20T14:12:33Z",
+ "items" : [
+ {
+ "id" : "TBOX-V400m-684-EU",
+ "name" : "V400m Package",
+ "quantity" : 1
+ },
+ {
+ "id" : "PART-175746-EU",
+ "name" : "Adyen Test Card",
+ "quantity" : 1
+ }
+ ]
+ }
+ },
+ "post-companies-companyId-users-create-user" : {
+ "summary" : "Create a user",
+ "description" : "Example request to create a user on the company level",
+ "value" : {
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "username" : "johnsmith",
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "roles" : [
+ "Merchant standard role",
+ "Merchant admin"
+ ],
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-users-create-user-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a user on the company level",
+ "value" : {
+ "id" : "S2-5C334C6770",
+ "name" : {
+ "firstName" : "John",
+ "gender" : "UNKNOWN",
+ "lastName" : "Smith"
+ },
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "username" : "johnsmith",
+ "roles" : [
+ "Merchant standard role",
+ "Merchant admin"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users/S2-5C334C6770"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-post-company-webhook" : {
+ "summary" : "Add a webhook configuration",
+ "description" : "Example request for adding a standard webhook configuration.",
+ "value" : {
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "username" : "YOUR_USER",
+ "password" : "YOUR_PASSWORD",
+ "active" : true,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "soap",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "populateSoapActionHeader" : false,
+ "filterMerchantAccountType" : "includeAccounts",
+ "filterMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-post-company-webhook-200" : {
+ "summary" : "OK 200 - Add a webhook configuration",
+ "description" : "Example response for adding a webhook configuration.",
+ "value" : {
+ "id" : "S2-6933523D2772",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",
+ "filterMerchantAccountType" : "includeAccounts",
+ "filterMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ],
+ "username" : "myuser",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "soap",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "certificateAlias" : "signed-test.adyen.com_2023",
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772"
+ },
+ "company" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/generateHmac"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/test"
+ }
+ }
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-generateHmac-post-company-webhook-generateHmac-200" : {
+ "summary" : "OK 200 - Generate a webhook HMAC key",
+ "description" : "Example response for generating a webhook HMAC.",
+ "value" : {
+ "hmacKey" : "7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902"
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test" : {
+ "summary" : "Test a webhook notification",
+ "description" : "Example request for testing a webhook notification.",
+ "value" : {
+ "notification" : {
+ "paymentMethod" : "visa",
+ "eventCode" : "AUTHORISATION",
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 2000
+ },
+ "reason" : "Authorize visa payment",
+ "success" : true
+ },
+ "types" : [
+ "CUSTOM"
+ ]
+ }
+ },
+ "post-companies-companyId-webhooks-webhookId-test-post-company-webhook-test-200" : {
+ "summary" : "OK 200 - Test a webhook notification",
+ "description" : "Example response for testing a webhook notification.",
+ "value" : {
+ "data" : [
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_AU",
+ "output" : "[accepted]",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_AU\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "657 ms",
+ "status" : "success"
+ },
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_EU",
+ "output" : "[accepted]",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_EU\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "590 ms",
+ "status" : "success"
+ },
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_US",
+ "output" : "[accepted]",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_US\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "248 ms",
+ "status" : "success"
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin" : {
+ "summary" : "Add an allowed origin for the API credential",
+ "description" : "Example request for adding an allowed origin for the API credential.",
+ "value" : {
+ "domain" : "https://www.eu.mystore.com"
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-apiCredentialId-allowedOrigins-add-allowed-origin-200" : {
+ "summary" : "OK 200 - Add an allowed origin for the API credential",
+ "description" : "Example response for adding an allowed origin for the API credential.",
+ "value" : {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.eu.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-post-merchant-credential" : {
+ "summary" : "Add an API credential",
+ "description" : "Example request for adding an API credential.",
+ "value" : {
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "allowedOrigins" : [
+ "https://www.mystore.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-apiCredentials-post-merchant-credential-200" : {
+ "summary" : "OK 200 - Add an API credential",
+ "description" : "Example response for adding an API credential.",
+ "value" : {
+ "id" : "YOUR_API_CREDENTIAL",
+ "username" : "YOUR_USERNAME",
+ "clientKey" : "YOUR_CLIENT_KEY",
+ "allowedIpAddresses" : [
+ ],
+ "roles" : [
+ "Checkout webservice role"
+ ],
+ "active" : true,
+ "allowedOrigins" : [
+ {
+ "id" : "YOUR_ALLOWED_ORIGIN",
+ "domain" : "https://www.mystore.com",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
+ }
+ }
+ }
+ ],
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL"
+ },
+ "allowedOrigins" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins"
+ },
+ "generateApiKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateApiKey"
+ },
+ "generateClientKey" : {
+ "href" : "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/generateClientKey"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ }
+ },
+ "apiKey" : "YOUR_API_KEY",
+ "password" : "YOUR_PASSWORD"
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model" : {
+ "summary" : "Request to add Swish",
+ "description" : "Example request to add Swish with a partner model setup",
+ "value" : {
+ "businessLineId" : "BL322KV223222D5F8H2J4BQ6C",
+ "storeIds" : [
+ "ST322LJ223223K5F4SQNR9XL5"
+ ],
+ "type" : "swish",
+ "swish" : {
+ "swishNumber" : "1231111111"
+ },
+ "currencies" : [
+ "SEK"
+ ],
+ "countries" : [
+ "SE"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-add-payment-method-partner-model-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after sending a request to add Swish in a partner model setup",
+ "value" : {
+ "id" : "PM3227C223224K5FH84M8CBNH",
+ "businessLineId" : "BL322KV223222D5F8H2J4BQ6C",
+ "storeIds" : [
+ "ST322LJ223223K5F4SQNR9XL5"
+ ],
+ "type" : "swish",
+ "countries" : [
+ "SE"
+ ],
+ "currencies" : [
+ "SEK"
+ ],
+ "swish" : {
+ "swishNumber" : "1231111111"
+ }
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain" : {
+ "summary" : "Add an Apple Pay domain",
+ "description" : "Example request to add an Apple Pay domain",
+ "value" : {
+ "domains" : [
+ "https://example.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-paymentMethodSettings-paymentMethodId-addApplePayDomains-add-applepay-domain-202" : {
+ "summary" : "Apple Pay domain requested - 202 OK",
+ "description" : "Example response after sending a request to add an Apple Pay domain",
+ "value" : {
+ "domains" : [
+ "https://example.com"
+ ]
+ }
+ },
+ "post-merchants-merchantId-shippingLocations-create-shipping-location" : {
+ "summary" : "Create a shipping location",
+ "description" : "Example request to create a shipping location",
+ "value" : {
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : "",
+ "country" : "ES"
+ },
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34 93 1234567",
+ "email" : "Rita.Perengano@company.com"
+ }
+ }
+ },
+ "post-merchants-merchantId-shippingLocations-create-shipping-location-200" : {
+ "summary" : "Shipping location created",
+ "description" : "Example response after creating a shipping location",
+ "value" : {
+ "id" : "S2-73536B20665526704F30792642212044452F714622375D477270",
+ "name" : "YOUR_MERCHANT_ACCOUNT Barcelona depot",
+ "contact" : {
+ "firstName" : "Rita",
+ "lastName" : "Perengano",
+ "phoneNumber" : "+34931234567",
+ "email" : "Rita.Perengano@company.com"
+ },
+ "address" : {
+ "companyName" : "YOUR_COMPANY",
+ "streetAddress" : "El quinto pino 42",
+ "postalCode" : "08012",
+ "city" : "Barcelona",
+ "stateOrProvince" : ""
+ }
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-post-splitConfiguration" : {
+ "summary" : "Create a split configuration",
+ "description" : "Example request to create a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "paymentMethod" : "ANY",
+ "shopperInteraction" : "ANY",
+ "fundingSource" : "ANY",
+ "currency" : "ANY",
+ "splitLogic" : {
+ "paymentFee" : "deductFromLiableAccount",
+ "chargeback" : "deductFromLiableAccount",
+ "tip" : "addToOneBalanceAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-post-splitConfiguration-200" : {
+ "summary" : "Split configuration created",
+ "description" : "Example response after creating a split configuration",
+ "value" : {
+ "description" : "Your description for the split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule" : {
+ "summary" : "Add rule to a split configuration",
+ "description" : "Example request to add a rule to a split configuration",
+ "value" : {
+ "paymentMethod" : "visa",
+ "shopperInteraction" : "POS",
+ "fundingSource" : "ANY",
+ "currency" : "USD",
+ "splitLogic" : {
+ "paymentFee" : "deductFromLiableAccount",
+ "chargeback" : "deductFromLiableAccount",
+ "tip" : "addToOneBalanceAccount",
+ "remainder" : "addToLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-splitConfigurations-splitConfigurationId-post-splitConfiguration-rule-200" : {
+ "summary" : "Split configuration created",
+ "description" : "Example response after creating a split configuration",
+ "value" : {
+ "description" : "My first split configuration",
+ "rules" : [
+ {
+ "currency" : "ANY",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "ANY",
+ "ruleId" : "SCRL4224P22322585HPCX384JW65VW",
+ "shopperInteraction" : "ANY",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX384JX52M2",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToOneBalanceAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ },
+ {
+ "currency" : "USD",
+ "fundingSource" : "ANY",
+ "paymentMethod" : "visa",
+ "ruleId" : "SCRL4224P22322585HPCX5V4KV6L2R",
+ "shopperInteraction" : "POS",
+ "splitLogic" : {
+ "additionalCommission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 50,
+ "balanceAccountId" : "BA3227C223222H5HQ2XX77VVH"
+ },
+ "chargeback" : "deductFromLiableAccount",
+ "commission" : {
+ "fixedAmount" : 10,
+ "variablePercentage" : 100
+ },
+ "splitLogicId" : "SCLG4224P22322585HPCX5V4KW26C9",
+ "paymentFee" : "deductFromLiableAccount",
+ "remainder" : "addToLiableAccount",
+ "tip" : "addToOneBalanceAccount"
+ }
+ }
+ ],
+ "splitConfigurationId" : "SCNF4224P22322585HPCX384JV6JGX"
+ }
+ },
+ "post-merchants-merchantId-stores-post-stores" : {
+ "summary" : "Create a store under the merchant account specified in the path.",
+ "description" : "Example request to create a store",
+ "value" : {
+ "description" : "City centre store",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "1813702551707653",
+ "reference" : "Spring_store_2",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ }
+ }
+ },
+ "post-merchants-merchantId-stores-post-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-create-order" : {
+ "summary" : "Create an order",
+ "description" : "Example request to create an order for terminal products",
+ "value" : {
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "shippingLocationId" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "billingEntityId" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-create-order-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Placed",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-terminalOrders-orderId-cancel-cancel-order-200" : {
+ "summary" : "Terminal order cancelled",
+ "description" : "Example response after cancelling an order for terminal products",
+ "value" : {
+ "id" : "4154567890100682",
+ "customerOrderReference" : "YOUR_REFERENCE",
+ "status" : "Cancelled",
+ "shippingLocation" : {
+ "id" : "S2-6A6C2E3432747D4F2F2C3455485E3836457D",
+ "name" : "YOUR_COMPANY Spain",
+ "contact" : {
+ "firstName" : "Pablo",
+ "lastName" : "Mengano",
+ "phoneNumber" : "+34911234567",
+ "email" : "Pablo.Mengano@company.com"
+ },
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43",
+ "streetAddress2" : "7 piso",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "billingEntity" : {
+ "id" : "MerchantAccount.YOUR_MERCHANT_ACCOUNT",
+ "name" : "YOUR_MERCHANT_ACCOUNT",
+ "taxId" : "ES1234567890",
+ "email" : "Pablo.Mengano@company.com",
+ "address" : {
+ "streetAddress" : "Paseo de la Castellana 43, 7",
+ "postalCode" : "28046",
+ "city" : "Madrid",
+ "country" : "ES"
+ }
+ },
+ "orderDate" : "2022-01-21T16:12:33Z",
+ "items" : [
+ {
+ "id" : "PART-287001-EU",
+ "name" : "Bluetooth Charging Base - V400m",
+ "quantity" : 2
+ },
+ {
+ "id" : "PART-620222-EU",
+ "name" : "Receipt Roll",
+ "quantity" : 20
+ }
+ ]
+ }
+ },
+ "post-merchants-merchantId-users-create-user" : {
+ "summary" : "Create a user",
+ "description" : "Example request to create a user on the merchant level",
+ "value" : {
+ "name" : {
+ "firstName" : "John",
+ "lastName" : "Smith"
+ },
+ "username" : "johnsmith",
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "roles" : [
+ "Merchant standard role"
+ ],
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-merchants-merchantId-users-create-user-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a user on the merchant level",
+ "value" : {
+ "id" : "S2-3B3C3C3B22",
+ "name" : {
+ "firstName" : "John",
+ "gender" : "UNKNOWN",
+ "lastName" : "Smith"
+ },
+ "email" : "john.smith@example.com",
+ "timeZoneCode" : "Europe/Amsterdam",
+ "username" : "johnsmith",
+ "roles" : [
+ "Merchant standard role"
+ ],
+ "active" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/users/S2-3B3C3C3B22"
+ }
+ },
+ "associatedMerchantAccounts" : [
+ "YOUR_MERCHANT_ACCOUNT"
+ ]
+ }
+ },
+ "post-merchants-merchantId-webhooks-post-merchant-webhook" : {
+ "summary" : "Add a webhook configuration",
+ "description" : "Example request for adding a standard webhook configuration.",
+ "value" : {
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "username" : "YOUR_USER",
+ "password" : "YOUR_PASSWORD",
+ "active" : true,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "populateSoapActionHeader" : false
+ }
+ },
+ "post-merchants-merchantId-webhooks-post-merchant-webhook-200" : {
+ "summary" : "OK 200 - Add a webhook configuration",
+ "description" : "Example response for adding a webhook configuration.",
+ "value" : {
+ "id" : "S2-31433949437F",
+ "type" : "standard",
+ "url" : "YOUR_WEBHOOK_URL",
+ "description" : "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE",
+ "username" : "myuser",
+ "hasPassword" : true,
+ "active" : true,
+ "hasError" : false,
+ "sslVersion" : "TLSv1.2",
+ "communicationFormat" : "json",
+ "acceptsExpiredCertificate" : false,
+ "acceptsSelfSignedCertificate" : true,
+ "acceptsUntrustedRootCertificate" : true,
+ "certificateAlias" : "signed-test.adyen.com_2023",
+ "populateSoapActionHeader" : false,
+ "additionalSettings" : {
+ "properties" : {
+ "includePosTerminalInfo" : false,
+ "includeARN" : false,
+ "includePosDetails" : false,
+ "includeCardInfoForRecurringContractNotification" : false,
+ "includeRiskData" : false,
+ "includeRiskExperimentReference" : false,
+ "includeSoapSecurityHeader" : false,
+ "includeContactlessWalletTokenInformation" : false,
+ "includeAcquirerReference" : false,
+ "includeRiskProfileReference" : false,
+ "includeOriginalMerchantReferenceCancelOrRefundNotification" : false,
+ "includeNfcTokenInformation" : false,
+ "includeSubvariant" : false,
+ "includeThreeDSVersion" : false,
+ "includeInstallmentsInfo" : false,
+ "includeAliasInfo" : false,
+ "includeShopperCountry" : false,
+ "includeRawThreeDSecureResult" : false,
+ "includeAirlineData" : false,
+ "includeGrossCurrencyChargebackDetails" : false,
+ "includeThreeDSecureResult" : false,
+ "includeMetadataIn3DSecurePaymentNotification" : false,
+ "includeOriginalReferenceForChargebackReversed" : false,
+ "addAcquirerResult" : false,
+ "includeDeliveryAddress" : false,
+ "includeRetryAttempts" : false,
+ "includeExtraCosts" : false,
+ "includeCardHolderName" : false,
+ "includeShopperDetail" : false,
+ "includeBankAccountDetails" : false,
+ "includeMandateDetails" : false,
+ "includeAuthAmountForDynamicZeroAuth" : false,
+ "includeIssuerCountry" : false,
+ "includeAcquirerErrorDetails" : false,
+ "includeCoBrandedWith" : false,
+ "includeShopperInteraction" : false,
+ "includeDeviceAndBrowserInfo" : false,
+ "addRawAcquirerResult" : false,
+ "includeCardBin" : false,
+ "includeFundingSource" : false,
+ "includeThreeDS2ChallengeInformation" : false,
+ "includeRiskProfile" : false,
+ "includeRealtimeAccountUpdaterStatus" : false,
+ "includeDunningProjectData" : false,
+ "includePaymentResultInOrderClosedNotification" : false,
+ "includeCardBinDetails" : false,
+ "includeNotesInManualReviewNotifications" : false,
+ "includeZeroAuthFlag" : false,
+ "addCaptureReferenceToDisputeNotification" : false,
+ "includePayPalDetails" : false,
+ "includeRawThreeDSecureDetailsResult" : false,
+ "includeBankVerificationResults" : false,
+ "includeCaptureDelayHours" : false,
+ "addPaymentAccountReference" : false,
+ "includePayULatamDetails" : false,
+ "includeStore" : false,
+ "returnAvsData" : false,
+ "includeWeChatPayOpenid" : false,
+ "includeUpiVpa" : false,
+ "includeCustomRoutingFlagging" : false,
+ "includeTokenisedPaymentMetaData" : false
+ }
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F"
+ },
+ "generateHmac" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/generateHmac"
+ },
+ "merchant" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT"
+ },
+ "testWebhook" : {
+ "href" : "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-31433949437F/test"
+ }
+ }
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-generateHmac-post-merchant-webhook-generateHmac-200" : {
+ "summary" : "OK 200 - Generate a webhook HMAC key",
+ "description" : "Example response for generating a webhook HMAC.",
+ "value" : {
+ "hmacKey" : "7052E6804F0AF40DCC390464C817F4F963516FA42AC8816D518DC5D39F41E902"
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test" : {
+ "summary" : "Test a webhook notification",
+ "description" : "Example request for testing a webhook notification.",
+ "value" : {
+ "notification" : {
+ "paymentMethod" : "visa",
+ "eventCode" : "AUTHORISATION",
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 1000
+ },
+ "reason" : "Authorize visa payment",
+ "success" : true
+ },
+ "types" : [
+ "CUSTOM"
+ ]
+ }
+ },
+ "post-merchants-merchantId-webhooks-webhookId-test-post-merchant-webhook-test-200" : {
+ "summary" : "OK 200 - Test a webhook notification",
+ "description" : "Example response for testing a webhook notification.",
+ "value" : {
+ "data" : [
+ {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT",
+ "output" : "[accepted]",
+ "requestSent" : "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T17:02:03+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT\",\"merchantReference\":\"4TZLD23Y\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"E05WW50L6IOBRGA0\",\"reason\":\"\",\"success\":\"true\"}}]}",
+ "responseCode" : "200",
+ "responseTime" : "532 ms",
+ "status" : "success"
+ }
+ ]
+ }
+ },
+ "post-merchants-post-merchants" : {
+ "summary" : "Create a merchant account for an Adyen for Platforms Manage integration",
+ "description" : "Example request for creating a merchant account",
+ "value" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "legalEntityId" : "YOUR_LEGAL_ENTITY_ID",
+ "businessLineId" : "YOUR_BUSINESS_LINE_ID",
+ "description" : "YOUR_DESCRIPTION",
+ "reference" : "YOUR_OWN_REFERENCE"
+ }
+ },
+ "post-merchants-post-merchants-200" : {
+ "summary" : "Merchant account created",
+ "description" : "Example response for creating a merchant account",
+ "value" : {
+ "companyId" : "YOUR_COMPANY_ACCOUNT",
+ "legalEntityId" : "YOUR_LEGAL_ENTITY_ID",
+ "businessLineId" : "YOUR_BUSINESS_LINE_ID",
+ "description" : "YOUR_DESCRIPTION",
+ "reference" : "YOUR_OWN_REFERENCE",
+ "id" : "YOUR_OWN_REFERENCE"
+ }
+ },
+ "post-stores-post-stores" : {
+ "summary" : "Create a store",
+ "description" : "Example request to create a store",
+ "value" : {
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "description" : "City centre store",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ }
+ }
+ },
+ "post-stores-post-stores-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after creating a store",
+ "value" : {
+ "id" : "YOUR_STORE_ID",
+ "address" : {
+ "country" : "US",
+ "line1" : "200 Main Street",
+ "line2" : "Building 5A",
+ "line3" : "Suite 3",
+ "city" : "Springfield",
+ "stateOrProvince" : "NY",
+ "postalCode" : "20250"
+ },
+ "description" : "City centre store",
+ "merchantId" : "YOUR_MERCHANT_ACCOUNT_ID",
+ "shopperStatement" : "Springfield Shop",
+ "phoneNumber" : "+1813702551707653",
+ "reference" : "Spring_store_2",
+ "status" : "active",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+ }
+ }
+ }
+ },
+ "post-terminals-scheduleActions-install-app" : {
+ "summary" : "Schedule installing an Android app",
+ "description" : "Example request to schedule installing an Android app",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "InstallAndroidApp",
+ "appId" : "ANDA422LZ223223K5F694GCCF732K8"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-install-app-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after scheduling the installation of an Android app",
+ "value" : {
+ "actionDetails" : {
+ "appId" : "ANDA422LZ223223K5F694GCCF732K8",
+ "type" : "InstallAndroidApp"
+ },
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "storeId" : "",
+ "items" : [
+ {
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "terminalId" : "S1E-000150183300032"
+ },
+ {
+ "id" : "TRAC4224X22338VQ5GD4CQJCQT5PC2",
+ "terminalId" : "S1E-000150183300033"
+ },
+ {
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ ],
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "terminalsWithErrors" : {
+
+ },
+ "totalScheduled" : 3,
+ "totalErrors" : 0
+ }
+ },
+ "post-terminals-scheduleActions-uninstall-cert" : {
+ "summary" : "Schedule uninstalling an Android certificate",
+ "description" : "Example request to schedule uninstalling an Android certificate",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "UninstallAndroidCertificate",
+ "certificateId" : "ANDC422LZ223223K5F78NVN9SL4VPH"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-uninstall-cert-200" : {
+ "summary" : "Response code - 200 OK",
+ "description" : "Example response after scheduling the removal of an Android certificate",
+ "value" : {
+ "actionDetails" : {
+ "certificateId" : "ANDC422LZ223223K5F78NVN9SL4VPH",
+ "type" : "UninstallAndroidCertificate"
+ },
+ "scheduledAt" : "2021-12-12T20:21:22-0100",
+ "storeId" : "",
+ "items" : [
+ {
+ "id" : "TRAC422T2223223K5GFMQHM6WQ4KB6",
+ "terminalId" : "S1E-000150183300032"
+ },
+ {
+ "id" : "TRAC4224X22338VQ5GD4CQJCQT5PC2",
+ "terminalId" : "S1E-000150183300033"
+ },
+ {
+ "id" : "TRAC4224Z223223K5GD89RLBWQ6CWT",
+ "terminalId" : "S1F2-000150183300034"
+ }
+ ],
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "terminalsWithErrors" : {
+
+ },
+ "totalScheduled" : 3,
+ "totalErrors" : 0
+ }
+ },
+ "post-terminals-scheduleActions-verification-error" : {
+ "summary" : "Invalid terminal ID in the request",
+ "description" : "Example request to see what validation errors look like",
+ "value" : {
+ "terminalIds" : [
+ "S1E-000150183300032",
+ "S1E-000150183300033",
+ "S1F2-000150183300034"
+ ],
+ "storeId" : "",
+ "scheduledAt" : "2021-12-11T20:21:22-0100",
+ "actionDetails" : {
+ "type" : "InstallAndroidApp",
+ "appId" : "ANDA422LZ223223K5F694GCCF621J7"
+ }
+ }
+ },
+ "post-terminals-scheduleActions-verification-error-422" : {
+ "summary" : "Response code - 422 Unprocessable Entity",
+ "description" : "Example response for failed verification of terminal IDs",
+ "value" : {
+ "type" : "https://docs.adyen.com/errors/unprocessable-entity",
+ "errorCode" : "02_005",
+ "title" : "Terminal ID verification failed.",
+ "status" : 422,
+ "detail" : "Terminal IDs are empty"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/SampleProject.yaml b/modules/openapi-generator/src/test/resources/3_0/jetbrains/SampleProject.yaml
new file mode 100644
index 000000000000..69a79b7eb145
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/SampleProject.yaml
@@ -0,0 +1,364 @@
+openapi: 3.1.0
+info:
+ title: Sample project
+ version: '1.0'
+ contact:
+ name: Beppe Catanese
+ email: gcatanese@yahoo.com
+ url: 'https://github.com/gcatanese'
+ description: 'Sample API Check "API Key" '
+ license:
+ name: Apache 2.0
+ url: 'https://github.com/gcatanese'
+servers:
+ - url: 'http://localhost:{port}/{version}'
+ description: dev server
+ variables:
+ port:
+ description: Port number
+ enum:
+ - '5000'
+ - '8080'
+ default: '5000'
+ version:
+ default: v1
+ description: API version
+ - url: 'http://localhost:{port}/{version}'
+ description: test server
+ variables:
+ port:
+ description: Port number
+ enum:
+ - '5000'
+ - '8080'
+ default: '5000'
+ version:
+ default: v1
+ description: API version
+paths:
+ '/users/':
+ get:
+ summary: Get User Info by Query Param
+ operationId: get-users-query-id
+ description: Retrieve the information of the user with the matching user ID.
+ tags:
+ - basic
+ parameters:
+ - description: Query Id.
+ name: pUserId
+ in: query
+ required: true
+ schema:
+ type: string
+ example: 888
+ - description: Custom HTTP header
+ name: Custom-Header
+ in: header
+ schema:
+ type: string
+ - description: Custom HTTP header with default
+ name: Another-Custom-Header
+ in: header
+ schema:
+ type: string
+ default: abc
+
+ responses:
+ '200':
+ description: User Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ example:
+ id: schema-example
+ firstName: Alice
+ lastName: Smith333
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ examples:
+ Get User Alice Smith:
+ value:
+ id: 142
+ firstName: Alice
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ Get User Phil Smith:
+ value:
+ id: 143
+ firstName: Phil
+ lastName: Smith
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ signUpDate: '2019-08-24'
+ '404':
+ description: User Not Found
+ '/users/{userId}':
+ parameters:
+ - schema:
+ type: integer
+ examples:
+ a:
+ value: 1
+ summary: a summary
+ b:
+ value: 2
+ summary: b summary
+ name: userId
+ in: path
+ required: true
+ description: Id of an existing user.
+ - schema:
+ type: string
+ default: code_one
+ name: strCode
+ in: header
+ description: Code as header
+ - schema:
+ type: string
+ name: strCode2
+ in: header
+ description: Code as header2
+ get:
+ summary: Get User Info by User ID
+ tags:
+ - advanced
+ responses:
+ '200':
+ description: User Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ example:
+ id: 9998
+ firstName: Alice9998 resp example
+ lastName: Smith9998
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ createDate: '2019-08-24'
+ '404':
+ description: User Not Found
+ operationId: get-users-userId
+ description: Retrieve the information of the user with the matching user ID.
+ patch:
+ summary: Update User Information
+ deprecated: true
+ operationId: patch-users-userId
+ responses:
+ '200':
+ description: User Updated
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ Updated User Rebecca Baker:
+ value:
+ id: 13
+ firstName: Rebecca
+ lastName: Baker
+ email: rebecca@gmail.com
+ dateOfBirth: '1985-10-02'
+ emailVerified: false
+ createDate: '2019-08-24'
+ '404':
+ description: User Not Found
+ '409':
+ description: Email Already Taken
+ description: Update the information of an existing user.
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ firstName:
+ type: string
+ lastName:
+ type: string
+ email:
+ type: string
+ description: >-
+ If a new email is given, the user's email verified property
+ will be set to false.
+ dateOfBirth:
+ type: string
+ examples:
+ Update First Name:
+ value:
+ firstName: Rebecca
+ Update Email:
+ value:
+ email: rebecca@gmail.com
+ Update Last Name & Date of Birth:
+ value:
+ lastName: Baker
+ dateOfBirth: '1985-10-02'
+ description: Patch user properties to update.
+ /user:
+ post:
+ summary: Create New User
+ operationId: post-user
+ responses:
+ '200':
+ description: User Created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ basic:
+ $ref: '#/components/examples/get-user-basic'
+ '400':
+ description: Missing Required Information
+ '409':
+ description: Email Already Taken
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ firstName:
+ type: string
+ lastName:
+ type: string
+ email:
+ type: string
+ dateOfBirth:
+ type: string
+ format: date
+ required:
+ - firstName
+ - lastName
+ - email
+ - dateOfBirth
+ examples:
+ basic:
+ $ref: '#/components/examples/get-user-basic'
+ description: Post the necessary fields for the API to create a new user.
+ description: Create a new user.
+ tags:
+ - basic
+ '/groups/{groupId}':
+ get:
+ summary: Get group by ID
+ tags:
+ - advanced
+ parameters:
+ - description: group Id
+ name: groupId
+ in: path
+ required: true
+ schema:
+ type: integer
+ default: 1
+ responses:
+ '200':
+ description: Group Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Group'
+ '404':
+ description: Group Not Found
+ operationId: get-groups-groupId
+ description: Get group of users
+
+components:
+ securitySchemes:
+ BasicAuth:
+ type: http
+ scheme: basic
+ BearerAuth:
+ type: http
+ scheme: bearer
+ ApiKeyAuth:
+ type: apiKey
+ name: X-API-Key
+ in: header
+ schemas:
+ User:
+ title: User
+ type: object
+ description: ''
+ example:
+ id: 999
+ firstName: Alice9 schema example
+ lastName: Smith9
+ email: alice.smith@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ createDate: '2019-08-24'
+ properties:
+ id:
+ type: integer
+ description: Unique identifier for the given user.
+ example: 0
+ firstName:
+ type: string
+ example: Alix
+ lastName:
+ type: string
+ example: Smith
+ email:
+ type: string
+ format: email
+ example: alix.smith@gmail.com
+ dateOfBirth:
+ type: string
+ format: date
+ example: '1997-10-31'
+ emailVerified:
+ type: boolean
+ description: Set to true if the user's email has been verified.
+ example: true
+ createDate:
+ type: string
+ format: date
+ description: The date that the user was created.
+ example: '2019-08-24'
+ required:
+ - id
+ - firstName
+ - lastName
+ - email
+ - emailVerified
+ Group:
+ title: Group
+ type: object
+ description: ''
+ properties:
+ id:
+ type: integer
+ description: Unique identifier for the given group.
+ name:
+ type: string
+ example: admin
+ required:
+ - id
+ - name
+ examples:
+ get-user-basic:
+ summary: Example request for Get User
+ value:
+ id: 777
+ firstName: Alotta
+ lastName: Rotta
+ email: alotta.rotta@gmail.com
+ dateOfBirth: '1997-10-31'
+ emailVerified: true
+ createDate: '2019-08-24'
+tags:
+ - name: basic
+ description: Basic tag
+ - name: advanced
+ description: Advanced tag
diff --git a/modules/openapi-generator/src/test/resources/3_0/jetbrains/github.json b/modules/openapi-generator/src/test/resources/3_0/jetbrains/github.json
new file mode 100644
index 000000000000..1fee47e06241
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/jetbrains/github.json
@@ -0,0 +1,308278 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "version": "1.1.4",
+ "title": "GitHub v3 REST API",
+ "description": "GitHub's v3 REST API.",
+ "license": {
+ "name": "MIT",
+ "url": "https://spdx.org/licenses/MIT"
+ },
+ "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
+ "contact": {
+ "name": "Support",
+ "url": "https://support.github.com/contact?tags=dotcom-rest-api"
+ },
+ "x-github-plan": "api.github.com"
+ },
+ "tags": [
+ {
+ "name": "actions",
+ "description": "Endpoints to manage GitHub Actions using the REST API."
+ },
+ {
+ "name": "activity",
+ "description": "Activity APIs provide access to notifications, subscriptions, and timelines."
+ },
+ {
+ "name": "apps",
+ "description": "Information for integrations and installations."
+ },
+ {
+ "name": "billing",
+ "description": "Monitor charges and usage from Actions and Packages."
+ },
+ {
+ "name": "checks",
+ "description": "Rich interactions with checks run by your integrations."
+ },
+ {
+ "name": "code-scanning",
+ "description": "Retrieve code scanning alerts from a repository."
+ },
+ {
+ "name": "codes-of-conduct",
+ "description": "Insight into codes of conduct for your communities."
+ },
+ {
+ "name": "emojis",
+ "description": "List emojis available to use on GitHub."
+ },
+ {
+ "name": "dependabot",
+ "description": "Endpoints to manage Dependabot."
+ },
+ {
+ "name": "dependency-graph",
+ "description": "Endpoints to access Dependency Graph features."
+ },
+ {
+ "name": "gists",
+ "description": "View, modify your gists."
+ },
+ {
+ "name": "git",
+ "description": "Raw Git functionality."
+ },
+ {
+ "name": "gitignore",
+ "description": "View gitignore templates"
+ },
+ {
+ "name": "issues",
+ "description": "Interact with GitHub Issues."
+ },
+ {
+ "name": "licenses",
+ "description": "View various OSS licenses."
+ },
+ {
+ "name": "markdown",
+ "description": "Render GitHub flavored markdown"
+ },
+ {
+ "name": "merge-queue",
+ "description": "Interact with GitHub Merge Queues."
+ },
+ {
+ "name": "meta",
+ "description": "Endpoints that give information about the API."
+ },
+ {
+ "name": "migrations",
+ "description": "Move projects to or from GitHub."
+ },
+ {
+ "name": "oidc",
+ "description": "Endpoints to manage GitHub OIDC configuration using the REST API."
+ },
+ {
+ "name": "orgs",
+ "description": "Interact with GitHub Orgs."
+ },
+ {
+ "name": "packages",
+ "description": "Manage packages for authenticated users and organizations."
+ },
+ {
+ "name": "projects",
+ "description": "Interact with GitHub Projects."
+ },
+ {
+ "name": "pulls",
+ "description": "Interact with GitHub Pull Requests."
+ },
+ {
+ "name": "rate-limit",
+ "description": "Check your current rate limit status"
+ },
+ {
+ "name": "reactions",
+ "description": "Interact with reactions to various GitHub entities."
+ },
+ {
+ "name": "repos",
+ "description": "Interact with GitHub Repos."
+ },
+ {
+ "name": "search",
+ "description": "Look for stuff on GitHub."
+ },
+ {
+ "name": "secret-scanning",
+ "description": "Retrieve secret scanning alerts from a repository."
+ },
+ {
+ "name": "teams",
+ "description": "Interact with GitHub Teams."
+ },
+ {
+ "name": "users",
+ "description": "Interact with and view information about users and also current user."
+ },
+ {
+ "name": "codespaces",
+ "description": "Endpoints to manage Codespaces using the REST API."
+ },
+ {
+ "name": "copilot",
+ "description": "Endpoints to manage Copilot using the REST API."
+ },
+ {
+ "name": "security-advisories",
+ "description": "Manage security advisories."
+ },
+ {
+ "name": "interactions",
+ "description": "Owner or admin management of users interactions."
+ },
+ {
+ "name": "classroom",
+ "description": "Interact with GitHub Classroom."
+ },
+ {
+ "name": "desktop",
+ "description": "Desktop specific endpoints."
+ }
+ ],
+ "servers": [
+ {
+ "url": "https://api.github.com"
+ }
+ ],
+ "externalDocs": {
+ "description": "GitHub v3 REST API",
+ "url": "https://docs.github.com/rest/"
+ },
+ "paths": {
+ "/": {
+ "get": {
+ "summary": "GitHub API Root",
+ "description": "Get Hypermedia links to resources accessible in GitHub's REST API",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/root",
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/root"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/root"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "meta",
+ "subcategory": "meta"
+ },
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/meta/meta#github-api-root"
+ }
+ }
+ },
+ "/advisories": {
+ "get": {
+ "summary": "List global security advisories",
+ "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/list-global-advisories",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories"
+ },
+ "parameters": [
+ {
+ "name": "ghsa_id",
+ "in": "query",
+ "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "type",
+ "in": "query",
+ "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "reviewed",
+ "malware",
+ "unreviewed"
+ ],
+ "default": "reviewed"
+ }
+ },
+ {
+ "name": "cve_id",
+ "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ecosystem",
+ "in": "query",
+ "description": "If specified, only advisories for these ecosystems will be returned.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "actions",
+ "composer",
+ "erlang",
+ "go",
+ "maven",
+ "npm",
+ "nuget",
+ "other",
+ "pip",
+ "pub",
+ "rubygems",
+ "rust"
+ ]
+ }
+ },
+ {
+ "name": "severity",
+ "in": "query",
+ "description": "If specified, only advisories with these severities will be returned.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "unknown",
+ "low",
+ "medium",
+ "high",
+ "critical"
+ ]
+ }
+ },
+ {
+ "name": "cwes",
+ "in": "query",
+ "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`",
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ {
+ "name": "is_withdrawn",
+ "in": "query",
+ "description": "Whether to only return advisories that have been withdrawn.",
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "affects",
+ "in": "query",
+ "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`",
+ "schema": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "maxItems": 1000,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ },
+ {
+ "name": "published",
+ "in": "query",
+ "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "updated",
+ "in": "query",
+ "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "modified",
+ "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "updated",
+ "published"
+ ],
+ "default": "published"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/global-advisory"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/global-advisory-items"
+ }
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too many requests",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "global-advisories"
+ }
+ }
+ },
+ "/advisories/{ghsa_id}": {
+ "get": {
+ "summary": "Get a global security advisory",
+ "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/get-global-advisory",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ghsa_id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/global-advisory"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/global-advisory"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "global-advisories"
+ }
+ }
+ },
+ "/app": {
+ "get": {
+ "summary": "Get the authenticated app",
+ "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-the-authenticated-app"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/integration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app-manifests/{code}/conversions": {
+ "post": {
+ "summary": "Create a GitHub App from a manifest",
+ "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-from-manifest",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest"
+ },
+ "parameters": [
+ {
+ "name": "code",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/integration"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "client_id": {
+ "type": "string"
+ },
+ "client_secret": {
+ "type": "string"
+ },
+ "webhook_secret": {
+ "type": "string",
+ "nullable": true
+ },
+ "pem": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "client_id",
+ "client_secret",
+ "webhook_secret",
+ "pem"
+ ],
+ "additionalProperties": true
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration-from-manifest"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app/hook/config": {
+ "get": {
+ "summary": "Get a webhook configuration for an app",
+ "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-webhook-config-for-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app"
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a webhook configuration for an app",
+ "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/update-webhook-config-for-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app"
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********",
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/app/hook/deliveries": {
+ "get": {
+ "summary": "List deliveries for an app webhook",
+ "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-webhook-deliveries",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/cursor"
+ },
+ {
+ "name": "redelivery",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/hook-delivery-item"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery-items"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/app/hook/deliveries/{delivery_id}": {
+ "get": {
+ "summary": "Get a delivery for an app webhook",
+ "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook-delivery"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/app/hook/deliveries/{delivery_id}/attempts": {
+ "post": {
+ "summary": "Redeliver a delivery for an app webhook",
+ "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/redeliver-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/app/installation-requests": {
+ "get": {
+ "summary": "List installation requests for the authenticated app",
+ "description": "Lists all the pending installation requests for the authenticated GitHub App.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installation-requests-for-authenticated-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of integration installation requests",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration-installation-request"
+ }
+ },
+ "examples": {
+ "exampleKey1": {
+ "$ref": "#/components/examples/integration-installation-request-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app/installations": {
+ "get": {
+ "summary": "List installations for the authenticated app",
+ "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "name": "outdated",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The permissions the installation has are included under the `permissions` key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/installation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-installation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}": {
+ "get": {
+ "summary": "Get an installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-installation"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ },
+ "delete": {
+ "summary": "Delete an installation for the authenticated app",
+ "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/delete-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}/access_tokens": {
+ "post": {
+ "summary": "Create an installation access token for an app",
+ "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. \n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. \n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-installation-access-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repositories": {
+ "description": "List of repository names that the token should have access to",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "rails"
+ }
+ },
+ "repository_ids": {
+ "description": "List of repository IDs that the token should have access to",
+ "example": [
+ 1
+ ],
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "permissions": {
+ "$ref": "#/components/schemas/app-permissions"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "Hello-World"
+ ],
+ "permissions": {
+ "issues": "write",
+ "contents": "read"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/installation-token"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/installation-token"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}/suspended": {
+ "put": {
+ "summary": "Suspend an app installation",
+ "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/suspend-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#suspend-an-app-installation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ },
+ "delete": {
+ "summary": "Unsuspend an app installation",
+ "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/unsuspend-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/applications/{client_id}/grant": {
+ "delete": {
+ "summary": "Delete an app authorization",
+ "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "operationId": "apps/delete-authorization",
+ "tags": [
+ "apps"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/client-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "access_token": {
+ "type": "string",
+ "description": "The OAuth access token used to authenticate to the GitHub API."
+ }
+ },
+ "required": [
+ "access_token"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "oauth-applications"
+ }
+ }
+ },
+ "/applications/{client_id}/token": {
+ "post": {
+ "summary": "Check a token",
+ "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/check-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/oauth-applications#check-a-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/client-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "access_token": {
+ "description": "The access_token of the OAuth or GitHub application.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "access_token"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authorization"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authorization-with-user"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "oauth-applications"
+ }
+ },
+ "patch": {
+ "summary": "Reset a token",
+ "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/reset-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/oauth-applications#reset-a-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/client-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "access_token": {
+ "description": "The access_token of the OAuth or GitHub application.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "access_token"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authorization"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authorization-with-user"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "oauth-applications"
+ }
+ },
+ "delete": {
+ "summary": "Delete an app token",
+ "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/delete-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/client-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "access_token": {
+ "type": "string",
+ "description": "The OAuth access token used to authenticate to the GitHub API."
+ }
+ },
+ "required": [
+ "access_token"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "oauth-applications"
+ }
+ }
+ },
+ "/applications/{client_id}/token/scoped": {
+ "post": {
+ "summary": "Create a scoped access token",
+ "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/scope-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/client-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "access_token": {
+ "type": "string",
+ "description": "The access token used to authenticate to the GitHub API.",
+ "example": "e72e16c7e42f292c6912e7710c838347ae178b4a"
+ },
+ "target": {
+ "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.",
+ "type": "string",
+ "example": "octocat"
+ },
+ "target_id": {
+ "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.",
+ "example": 1,
+ "type": "integer"
+ },
+ "repositories": {
+ "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "rails"
+ }
+ },
+ "repository_ids": {
+ "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.",
+ "example": [
+ 1
+ ],
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "permissions": {
+ "$ref": "#/components/schemas/app-permissions"
+ }
+ },
+ "required": [
+ "access_token"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a",
+ "target": "octocat",
+ "permissions": {
+ "metadata": "read",
+ "issues": "write",
+ "contents": "read"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authorization"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/scope-token"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/apps/{app_slug}": {
+ "get": {
+ "summary": "Get an app",
+ "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-by-slug",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-an-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/app-slug"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/integration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/assignments/{assignment_id}": {
+ "get": {
+ "summary": "Get an assignment",
+ "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/get-an-assignment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/assignment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/classroom-assignment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/classroom-assignment"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/assignments/{assignment_id}/accepted_assignments": {
+ "get": {
+ "summary": "List accepted assignments for an assignment",
+ "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/list-accepted-assigments-for-an-assignment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/assignment-id"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/classroom-accepted-assignment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/classroom-accepted-assignment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/assignments/{assignment_id}/grades": {
+ "get": {
+ "summary": "Get assignment grades",
+ "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/get-assignment-grades",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/assignment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/classroom-assignment-grade"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/classroom-assignment-grades"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/classrooms": {
+ "get": {
+ "summary": "List classrooms",
+ "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/list-classrooms",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-classroom"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-classroom"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/classrooms/{classroom_id}": {
+ "get": {
+ "summary": "Get a classroom",
+ "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/get-a-classroom",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/classroom-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/classroom"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/classroom"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/classrooms/{classroom_id}/assignments": {
+ "get": {
+ "summary": "List assignments for a classroom",
+ "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.",
+ "tags": [
+ "classroom"
+ ],
+ "operationId": "classroom/list-assignments-for-a-classroom",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/classroom-id"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-classroom-assignment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "classroom",
+ "subcategory": "classroom"
+ }
+ }
+ },
+ "/codes_of_conduct": {
+ "get": {
+ "summary": "Get all codes of conduct",
+ "description": "Returns array of all GitHub's codes of conduct.",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-all-codes-of-conduct",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-of-conduct"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-of-conduct-simple-items"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codes-of-conduct",
+ "subcategory": "codes-of-conduct"
+ }
+ }
+ },
+ "/codes_of_conduct/{key}": {
+ "get": {
+ "summary": "Get a code of conduct",
+ "description": "Returns information about the specified GitHub code of conduct.",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-conduct-code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct"
+ },
+ "parameters": [
+ {
+ "name": "key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-of-conduct"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-of-conduct"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codes-of-conduct",
+ "subcategory": "codes-of-conduct"
+ }
+ }
+ },
+ "/emojis": {
+ "get": {
+ "summary": "Get emojis",
+ "description": "Lists all the emojis available to use on GitHub.",
+ "operationId": "emojis/get",
+ "tags": [
+ "emojis"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/emojis/emojis#get-emojis"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/emojis-get"
+ }
+ }
+ }
+ },
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "emojis",
+ "subcategory": "emojis"
+ }
+ }
+ },
+ "/enterprises/{enterprise}/dependabot/alerts": {
+ "get": {
+ "summary": "List Dependabot alerts for an enterprise",
+ "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-alerts-for-enterprise",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/enterprise"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-states"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-scope"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-first"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-last"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/dependabot-alert-with-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-alerts-for-organization"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "dependabot",
+ "subcategory": "alerts"
+ }
+ }
+ },
+ "/enterprises/{enterprise}/secret-scanning/alerts": {
+ "get": {
+ "summary": "List secret scanning alerts for an enterprise",
+ "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\n\nAlerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\n\nThe authenticated user must be a member of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.",
+ "tags": [
+ "secret-scanning"
+ ],
+ "operationId": "secret-scanning/list-alerts-for-enterprise",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/enterprise"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-state"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-secret-type"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-resolution"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-validity"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-secret-scanning-alert"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-secret-scanning-alert-list"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ }
+ },
+ "/events": {
+ "get": {
+ "summary": "List public events",
+ "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-public-events"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-events-items"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/feeds": {
+ "get": {
+ "summary": "Get feeds",
+ "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-feeds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/feeds#get-feeds"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/feed"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/feed"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "feeds"
+ }
+ }
+ },
+ "/gists": {
+ "get": {
+ "summary": "List gists for the authenticated user",
+ "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/base-gist"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-gist-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "post": {
+ "summary": "Create a gist",
+ "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.",
+ "operationId": "gists/create",
+ "tags": [
+ "gists"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#create-a-gist"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "description": {
+ "description": "Description of the gist",
+ "example": "Example Ruby script",
+ "type": "string"
+ },
+ "files": {
+ "description": "Names and content for the files that make up the gist",
+ "example": {
+ "hello.rb": {
+ "content": "puts \"Hello, World!\""
+ }
+ },
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "Content of the file",
+ "readOnly": false,
+ "type": "string"
+ }
+ },
+ "required": [
+ "content"
+ ]
+ }
+ },
+ "public": {
+ "oneOf": [
+ {
+ "description": "Flag indicating whether the gist is public",
+ "example": true,
+ "type": "boolean",
+ "default": false
+ },
+ {
+ "type": "string",
+ "example": "true",
+ "default": "false",
+ "enum": [
+ "true",
+ "false"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "files"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Creating a gist",
+ "value": {
+ "description": "Example of a gist",
+ "public": false,
+ "files": {
+ "README.md": {
+ "content": "Hello World"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-simple"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/public": {
+ "get": {
+ "summary": "List public gists",
+ "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-public-gists"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/base-gist"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-gist-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/starred": {
+ "get": {
+ "summary": "List starred gists",
+ "description": "List the authenticated user's starred gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-starred-gists"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/base-gist"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-gist-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/{gist_id}": {
+ "get": {
+ "summary": "Get a gist",
+ "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#get-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-simple"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden_gist"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "patch": {
+ "summary": "Update a gist",
+ "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#update-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "description": {
+ "description": "The description of the gist.",
+ "example": "Example Ruby script",
+ "type": "string"
+ },
+ "files": {
+ "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be\ndeleted if the specified object does not contain at least one of `content` or `filename`.",
+ "example": {
+ "hello.rb": {
+ "content": "blah",
+ "filename": "goodbye.rb"
+ }
+ },
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "content": {
+ "description": "The new content of the file.",
+ "type": "string"
+ },
+ "filename": {
+ "description": "The new filename for the file.",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "type": "object",
+ "nullable": true
+ },
+ "examples": {
+ "updateGist": {
+ "summary": "Updating a gist",
+ "value": {
+ "description": "An updated gist description",
+ "files": {
+ "README.md": {
+ "content": "Hello World from GitHub"
+ }
+ }
+ }
+ },
+ "deleteFile": {
+ "summary": "Deleting a gist file",
+ "value": {
+ "files": {
+ "hello.py": null
+ }
+ }
+ },
+ "renameFile": {
+ "summary": "Renaming a gist file",
+ "value": {
+ "files": {
+ "hello.py": {
+ "filename": "goodbye.py"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-simple"
+ },
+ "examples": {
+ "updateGist": {
+ "$ref": "#/components/examples/gist"
+ },
+ "deleteFile": {
+ "$ref": "#/components/examples/delete-gist-file"
+ },
+ "renameFile": {
+ "$ref": "#/components/examples/rename-gist-file"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "delete": {
+ "summary": "Delete a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#delete-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/{gist_id}/comments": {
+ "get": {
+ "summary": "List gist comments",
+ "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/comments#list-gist-comments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gist-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create a gist comment",
+ "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/comments#create-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "body": {
+ "description": "The comment text.",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Creating a comment in a gist",
+ "value": {
+ "body": "This is a comment to a gist"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-comment"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/gists/{gist_id}/comments/{comment_id}": {
+ "get": {
+ "summary": "Get a gist comment",
+ "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/comments#get-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-comment"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden_gist"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "comments"
+ }
+ },
+ "patch": {
+ "summary": "Update a gist comment",
+ "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/comments#update-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "body": {
+ "description": "The comment text.",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment"
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Updating a comment in a gist",
+ "value": {
+ "body": "This is an update to a comment in a gist"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-comment"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "comments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a gist comment",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/comments#delete-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/gists/{gist_id}/commits": {
+ "get": {
+ "summary": "List gist commits",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-gist-commits"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gist-commit"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-commit-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/{gist_id}/forks": {
+ "get": {
+ "summary": "List gist forks",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-gist-forks"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gist-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist-fork-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "post": {
+ "summary": "Fork a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#fork-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/base-gist"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-gist"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/{gist_id}/star": {
+ "get": {
+ "summary": "Check if a gist is starred",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/check-is-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if gist is starred"
+ },
+ "404": {
+ "description": "Not Found if gist is not starred",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "put": {
+ "summary": "Star a gist",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/star",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#star-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ },
+ "delete": {
+ "summary": "Unstar a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/unstar",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#unstar-a-gist"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gists/{gist_id}/{sha}": {
+ "get": {
+ "summary": "Get a gist revision",
+ "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get-revision",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#get-a-gist-revision"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gist-id"
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gist-simple"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gist"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/gitignore/templates": {
+ "get": {
+ "summary": "Get all gitignore templates",
+ "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).",
+ "operationId": "gitignore/get-all-templates",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "Actionscript",
+ "Android",
+ "AppceleratorTitanium",
+ "Autotools",
+ "Bancha",
+ "C",
+ "C++"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "gitignore",
+ "subcategory": "gitignore"
+ }
+ }
+ },
+ "/gitignore/templates/{name}": {
+ "get": {
+ "summary": "Get a gitignore template",
+ "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.",
+ "operationId": "gitignore/get-template",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template"
+ },
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gitignore-template"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gitignore-template"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "gitignore",
+ "subcategory": "gitignore"
+ }
+ }
+ },
+ "/installation/repositories": {
+ "get": {
+ "summary": "List repositories accessible to the app installation",
+ "description": "List repositories that an app installation can access.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-repos-accessible-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "repository_selection": {
+ "type": "string",
+ "example": "selected"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-paginated-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/installation/token": {
+ "delete": {
+ "summary": "Revoke an installation access token",
+ "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce 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 \"[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/revoke-installation-access-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/issues": {
+ "get": {
+ "summary": "List issues assigned to the authenticated user",
+ "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "assigned",
+ "created",
+ "mentioned",
+ "subscribed",
+ "repos",
+ "all"
+ ],
+ "default": "assigned"
+ }
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/labels"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "name": "collab",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "orgs",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "owned",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "pulls",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-with-repo-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/licenses": {
+ "get": {
+ "summary": "Get all commonly used licenses",
+ "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-all-commonly-used",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses"
+ },
+ "parameters": [
+ {
+ "name": "featured",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/license-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/license-simple-items"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "licenses",
+ "subcategory": "licenses"
+ }
+ }
+ },
+ "/licenses/{license}": {
+ "get": {
+ "summary": "Get a license",
+ "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/licenses/licenses#get-a-license"
+ },
+ "parameters": [
+ {
+ "name": "license",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/license"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/license"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "licenses",
+ "subcategory": "licenses"
+ }
+ }
+ },
+ "/markdown": {
+ "post": {
+ "summary": "Render a Markdown document",
+ "description": "",
+ "operationId": "markdown/render",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "text": {
+ "description": "The Markdown text to render in HTML.",
+ "type": "string"
+ },
+ "mode": {
+ "description": "The rendering mode.",
+ "enum": [
+ "markdown",
+ "gfm"
+ ],
+ "default": "markdown",
+ "example": "markdown",
+ "type": "string"
+ },
+ "context": {
+ "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "text"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Rendering markdown",
+ "value": {
+ "text": "Hello **world**"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "headers": {
+ "Content-Type": {
+ "$ref": "#/components/headers/content-type"
+ },
+ "Content-Length": {
+ "example": "279",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "X-CommonMarker-Version": {
+ "$ref": "#/components/headers/x-common-marker-version"
+ }
+ },
+ "content": {
+ "text/html": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "summary": "Example response",
+ "value": "Hello world
"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "markdown",
+ "subcategory": "markdown"
+ }
+ }
+ },
+ "/markdown/raw": {
+ "post": {
+ "summary": "Render a Markdown document in raw mode",
+ "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.",
+ "operationId": "markdown/render-raw",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "text": "Hello **world**"
+ }
+ }
+ }
+ },
+ "text/x-markdown": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "summary": "Rendering markdown",
+ "value": {
+ "text": "Hello **world**"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "headers": {
+ "X-CommonMarker-Version": {
+ "$ref": "#/components/headers/x-common-marker-version"
+ }
+ },
+ "content": {
+ "text/html": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "summary": "Example response",
+ "value": "Hello world
"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "markdown",
+ "subcategory": "markdown"
+ }
+ }
+ },
+ "/marketplace_listing/accounts/{account_id}": {
+ "get": {
+ "summary": "Get a subscription plan for an account",
+ "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-subscription-plan-for-account",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/account-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/marketplace-purchase"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-purchase"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found when the account has not purchased the listing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/marketplace_listing/plans": {
+ "get": {
+ "summary": "List plans",
+ "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-plans",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-plans"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/marketplace-listing-plan"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-listing-plan-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/marketplace_listing/plans/{plan_id}/accounts": {
+ "get": {
+ "summary": "List accounts for a plan",
+ "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-accounts-for-plan",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/plan-id"
+ },
+ {
+ "$ref": "#/components/parameters/sort"
+ },
+ {
+ "name": "direction",
+ "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/marketplace-purchase"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-purchase-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/marketplace_listing/stubbed/accounts/{account_id}": {
+ "get": {
+ "summary": "Get a subscription plan for an account (stubbed)",
+ "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-subscription-plan-for-account-stubbed",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/account-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/marketplace-purchase"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-purchase"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found when the account has not purchased the listing"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/marketplace_listing/stubbed/plans": {
+ "get": {
+ "summary": "List plans (stubbed)",
+ "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-plans-stubbed",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-plans-stubbed"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/marketplace-listing-plan"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-listing-plan-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/marketplace_listing/stubbed/plans/{plan_id}/accounts": {
+ "get": {
+ "summary": "List accounts for a plan (stubbed)",
+ "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-accounts-for-plan-stubbed",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/plan-id"
+ },
+ {
+ "$ref": "#/components/parameters/sort"
+ },
+ {
+ "name": "direction",
+ "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/marketplace-purchase"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/marketplace-purchase-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/meta": {
+ "get": {
+ "summary": "Get GitHub meta information",
+ "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/meta/meta#get-apiname-meta-information"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/api-overview"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/api-overview"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "meta",
+ "subcategory": "meta"
+ }
+ }
+ },
+ "/networks/{owner}/{repo}/events": {
+ "get": {
+ "summary": "List public events for a network of repositories",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-repo-network",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repo-events-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/notifications": {
+ "get": {
+ "summary": "List notifications for the authenticated user",
+ "description": "List all notifications for the current user, sorted by most recently updated.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-notifications-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/all"
+ },
+ {
+ "$ref": "#/components/parameters/participating"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/before"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 50
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/thread"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/thread-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "put": {
+ "summary": "Mark notifications as read",
+ "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#mark-notifications-as-read"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "last_read_at": {
+ "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "read": {
+ "description": "Whether the notification has been read.",
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "last_read_at": "2022-06-10T00:00:00Z",
+ "read": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/notifications-mark-read"
+ }
+ }
+ }
+ }
+ },
+ "205": {
+ "description": "Reset Content"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ }
+ },
+ "/notifications/threads/{thread_id}": {
+ "get": {
+ "summary": "Get a thread",
+ "description": "Gets information about a notification thread.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-thread",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#get-a-thread"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/thread"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/thread"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "patch": {
+ "summary": "Mark a thread as read",
+ "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-thread-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "responses": {
+ "205": {
+ "description": "Reset Content"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "delete": {
+ "summary": "Mark a thread as done",
+ "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-thread-as-done",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ }
+ },
+ "/notifications/threads/{thread_id}/subscription": {
+ "get": {
+ "summary": "Get a thread subscription for the authenticated user",
+ "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-thread-subscription-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/thread-subscription"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/thread-subscription"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "put": {
+ "summary": "Set a thread subscription",
+ "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#set-a-thread-subscription"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "ignored": {
+ "description": "Whether to block all notifications from a thread.",
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ignored": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/thread-subscription"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/thread-subscription"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "delete": {
+ "summary": "Delete a thread subscription",
+ "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/thread-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ }
+ },
+ "/octocat": {
+ "get": {
+ "summary": "Get Octocat",
+ "description": "Get the octocat as ASCII art",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-octocat",
+ "parameters": [
+ {
+ "name": "s",
+ "in": "query",
+ "description": "The words to show in Octocat's speech bubble",
+ "schema": {
+ "type": "string"
+ },
+ "required": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/octocat-stream": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/meta/meta#get-octocat"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "meta",
+ "subcategory": "meta"
+ }
+ }
+ },
+ "/organizations": {
+ "get": {
+ "summary": "List organizations",
+ "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#list-organizations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since-org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}": {
+ "get": {
+ "summary": "Get an organization",
+ "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-full"
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/organization-full"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ },
+ "patch": {
+ "summary": "Update an organization",
+ "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "billing_email": {
+ "type": "string",
+ "description": "Billing email address. This address is not publicized."
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name."
+ },
+ "email": {
+ "type": "string",
+ "description": "The publicly visible email address."
+ },
+ "twitter_username": {
+ "type": "string",
+ "description": "The Twitter username of the company."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location."
+ },
+ "name": {
+ "type": "string",
+ "description": "The shorthand name of the company."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the company."
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "description": "Whether an organization can use organization projects."
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "description": "Whether repositories that belong to the organization can use repository projects."
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "description": "Default permission level members have for organization repositories.",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ],
+ "default": "read"
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.",
+ "default": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.",
+ "default": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.",
+ "default": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.",
+ "default": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "description": "Whether organization members can fork private organization repositories.",
+ "default": false
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.",
+ "default": false
+ },
+ "blog": {
+ "type": "string",
+ "example": "\"http://github.blog\""
+ },
+ "advanced_security_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "dependabot_alerts_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "dependabot_security_updates_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "dependency_graph_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "secret_scanning_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "secret_scanning_push_protection_enabled_for_new_repositories": {
+ "type": "boolean",
+ "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
+ },
+ "secret_scanning_push_protection_custom_link_enabled": {
+ "type": "boolean",
+ "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."
+ },
+ "secret_scanning_push_protection_custom_link": {
+ "type": "string",
+ "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-full"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/validation-error"
+ },
+ {
+ "$ref": "#/components/schemas/validation-error-simple"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization",
+ "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service",
+ "operationId": "orgs/delete",
+ "tags": [
+ "orgs"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/actions/cache/usage": {
+ "get": {
+ "summary": "Get GitHub Actions cache usage for an organization",
+ "description": "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.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-actions-cache-usage-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-cache-usage-org-enterprise"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-cache-usage-org-enterprise"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ }
+ },
+ "/orgs/{org}/actions/cache/usage-by-repository": {
+ "get": {
+ "summary": "List repositories with GitHub Actions cache usage for an organization",
+ "description": "Lists repositories and their 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.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-actions-cache-usage-by-repo-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repository_cache_usages"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repository_cache_usages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-cache-usage-by-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-actions-cache-usage-by-repo"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ }
+ },
+ "/orgs/{org}/actions/oidc/customization/sub": {
+ "get": {
+ "summary": "Get the customization template for an OIDC subject claim for an organization",
+ "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.",
+ "tags": [
+ "oidc"
+ ],
+ "operationId": "oidc/get-oidc-custom-sub-template-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A JSON serialized template for OIDC subject claim customization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/oidc-custom-sub"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/oidc-custom-sub"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "oidc"
+ }
+ },
+ "put": {
+ "summary": "Set the customization template for an OIDC subject claim for an organization",
+ "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.",
+ "tags": [
+ "oidc"
+ ],
+ "operationId": "oidc/update-oidc-custom-sub-template-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/oidc-custom-sub"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/oidc-custom-sub"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Empty response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "oidc"
+ }
+ }
+ },
+ "/orgs/{org}/actions/permissions": {
+ "get": {
+ "summary": "Get GitHub Actions permissions for an organization",
+ "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/get-github-actions-permissions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-organization-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-organization-permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set GitHub Actions permissions for an organization",
+ "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/set-github-actions-permissions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enabled_repositories": {
+ "$ref": "#/components/schemas/enabled-repositories"
+ },
+ "allowed_actions": {
+ "$ref": "#/components/schemas/allowed-actions"
+ }
+ },
+ "required": [
+ "enabled_repositories"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "enabled_repositories": "all",
+ "allowed_actions": "selected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/orgs/{org}/actions/permissions/repositories": {
+ "get": {
+ "summary": "List selected repositories enabled for GitHub Actions in an organization",
+ "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/list-selected-repositories-enabled-github-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "number"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-paginated"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories enabled for GitHub Actions in an organization",
+ "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/set-selected-repositories-enabled-github-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "description": "List of repository IDs to enable for GitHub Actions.",
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "Unique identifier of the repository."
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ 32,
+ 42
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/orgs/{org}/actions/permissions/repositories/{repository_id}": {
+ "put": {
+ "summary": "Enable a selected repository for GitHub Actions in an organization",
+ "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/enable-selected-repository-github-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/repository-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "delete": {
+ "summary": "Disable a selected repository for GitHub Actions in an organization",
+ "description": "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 `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/disable-selected-repository-github-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/repository-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/orgs/{org}/actions/permissions/selected-actions": {
+ "get": {
+ "summary": "Get allowed actions and reusable workflows for an organization",
+ "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/get-allowed-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/selected-actions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/selected-actions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set allowed actions and reusable workflows for an organization",
+ "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "operationId": "actions/set-allowed-actions-organization",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/selected-actions"
+ },
+ "examples": {
+ "selected_actions": {
+ "$ref": "#/components/examples/selected-actions"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/orgs/{org}/actions/permissions/workflow": {
+ "get": {
+ "summary": "Get default workflow permissions for an organization",
+ "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-github-actions-default-workflow-permissions-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-get-default-workflow-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-default-workflow-permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set default workflow permissions for an organization",
+ "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-github-actions-default-workflow-permissions-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success response"
+ }
+ },
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-set-default-workflow-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-default-workflow-permissions"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners": {
+ "get": {
+ "summary": "List self-hosted runners for an organization",
+ "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-self-hosted-runners-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "name",
+ "description": "The name of a self-hosted runner.",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "runners"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "runners": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/downloads": {
+ "get": {
+ "summary": "List runner applications for an organization",
+ "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-runner-applications-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner-application"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-application-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/generate-jitconfig": {
+ "post": {
+ "summary": "Create configuration for a just-in-time runner for an organization",
+ "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/generate-runner-jitconfig-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "name",
+ "runner_group_id",
+ "labels"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the new runner."
+ },
+ "runner_group_id": {
+ "type": "integer",
+ "description": "The ID of the runner group to register the runner to."
+ },
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 100,
+ "items": {
+ "type": "string"
+ },
+ "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100."
+ },
+ "work_folder": {
+ "type": "string",
+ "description": "The working directory to be used for job execution, relative to the runner install directory.",
+ "default": "_work"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "New runner",
+ "runner_group_id": 1,
+ "labels": [
+ "self-hosted",
+ "X64",
+ "macOS",
+ "no-gpu"
+ ],
+ "work_folder": "_work"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "$ref": "#/components/responses/actions_runner_jitconfig"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/registration-token": {
+ "post": {
+ "summary": "Create a registration token for an organization",
+ "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-registration-token-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authentication-token"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authentication-token"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/remove-token": {
+ "post": {
+ "summary": "Create a remove token for an organization",
+ "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-remove-token-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authentication-token"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authentication-token-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/{runner_id}": {
+ "get": {
+ "summary": "Get a self-hosted runner for an organization",
+ "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/runner"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "delete": {
+ "summary": "Delete a self-hosted runner from an organization",
+ "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-self-hosted-runner-from-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/{runner_id}/labels": {
+ "get": {
+ "summary": "List labels for a self-hosted runner for an organization",
+ "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-labels-for-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "post": {
+ "summary": "Add custom labels to a self-hosted runner for an organization",
+ "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "labels"
+ ],
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 100,
+ "description": "The names of the custom labels to add to the runner.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "gpu",
+ "accelerated"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "put": {
+ "summary": "Set custom labels for a self-hosted runner for an organization",
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "labels"
+ ],
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 0,
+ "maxItems": 100,
+ "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "gpu",
+ "accelerated"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "delete": {
+ "summary": "Remove all custom labels from a self-hosted runner for an organization",
+ "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels_readonly"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": {
+ "delete": {
+ "summary": "Remove a custom label from a self-hosted runner for an organization",
+ "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ },
+ {
+ "$ref": "#/components/parameters/runner-label-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/orgs/{org}/actions/secrets": {
+ "get": {
+ "summary": "List organization secrets",
+ "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-org-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-actions-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-actions-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/actions/secrets/public-key": {
+ "get": {
+ "summary": "Get an organization public key",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-org-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/actions/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get an organization secret",
+ "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-actions-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-actions-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update an organization secret",
+ "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-or-update-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ },
+ "visibility": {
+ "type": "string",
+ "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ]
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "visibility"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 1296269,
+ 1296280
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization secret",
+ "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/actions/secrets/{secret_name}/repositories": {
+ "get": {
+ "summary": "List selected repositories for an organization secret",
+ "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repository-paginated"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories for an organization secret",
+ "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ 64780797
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add selected repository to an organization secret",
+ "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/add-selected-repo-to-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when repository was added to the selected list"
+ },
+ "409": {
+ "description": "Conflict when visibility type is not set to selected"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Remove selected repository from an organization secret",
+ "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-selected-repo-from-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response when repository was removed from the selected list"
+ },
+ "409": {
+ "description": "Conflict when visibility type not set to selected"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/actions/variables": {
+ "get": {
+ "summary": "List organization variables",
+ "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-org-variables",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#list-organization-variables"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variables-per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "variables"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "variables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-actions-variable"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-actions-variables-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "post": {
+ "summary": "Create an organization variable",
+ "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ },
+ "visibility": {
+ "type": "string",
+ "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ]
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "value",
+ "visibility"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 1296269,
+ 1296280
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a variable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/orgs/{org}/actions/variables/{name}": {
+ "get": {
+ "summary": "Get an organization variable",
+ "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-actions-variable"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-actions-variable"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "patch": {
+ "summary": "Update an organization variable",
+ "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/update-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ },
+ "visibility": {
+ "type": "string",
+ "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ]
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 1296269,
+ 1296280
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization variable",
+ "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/orgs/{org}/actions/variables/{name}/repositories": {
+ "get": {
+ "summary": "List selected repositories for an organization variable",
+ "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-selected-repos-for-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repository-paginated"
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Response when the visibility of the variable is not set to `selected`"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories for an organization variable",
+ "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-selected-repos-for-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "The IDs of the repositories that can access the organization variable.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ 64780797
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "description": "Response when the visibility of the variable is not set to `selected`"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add selected repository to an organization variable",
+ "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/add-selected-repo-to-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "description": "Response when the visibility of the variable is not set to `selected`"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "delete": {
+ "summary": "Remove selected repository from an organization variable",
+ "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-selected-repo-from-org-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "description": "Response when the visibility of the variable is not set to `selected`"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/orgs/{org}/blocks": {
+ "get": {
+ "summary": "List users blocked by an organization",
+ "description": "List the users blocked by an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-blocked-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "blocking"
+ }
+ }
+ },
+ "/orgs/{org}/blocks/{username}": {
+ "get": {
+ "summary": "Check if a user is blocked by an organization",
+ "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/check-blocked-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "If the user is blocked"
+ },
+ "404": {
+ "description": "If the user is not blocked",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "blocking"
+ }
+ },
+ "put": {
+ "summary": "Block a user from an organization",
+ "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/block-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "blocking"
+ }
+ },
+ "delete": {
+ "summary": "Unblock a user from an organization",
+ "description": "Unblocks the given user on behalf of the specified organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/unblock-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "blocking"
+ }
+ }
+ },
+ "/orgs/{org}/code-scanning/alerts": {
+ "get": {
+ "summary": "List code scanning alerts for an organization",
+ "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/list-alerts-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/tool-name"
+ },
+ {
+ "$ref": "#/components/parameters/tool-guid"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "state",
+ "description": "If specified, only code scanning alerts with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert-state-query"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "severity",
+ "description": "If specified, only code scanning alerts with this severity will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert-severity"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-organization-alert-items"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-organization-alert-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces": {
+ "get": {
+ "summary": "List codespaces for the organization",
+ "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-in-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "codespaces"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "codespaces": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-list"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/access": {
+ "put": {
+ "summary": "Manage access control for organization codespaces",
+ "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/set-codespaces-access",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "deprecated": true,
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "visibility": {
+ "type": "string",
+ "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
+ "enum": [
+ "disabled",
+ "selected_members",
+ "all_members",
+ "all_members_and_outside_collaborators"
+ ]
+ },
+ "selected_usernames": {
+ "type": "array",
+ "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "visibility"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "visibility": "selected_members",
+ "selected_usernames": [
+ "johnDoe",
+ "atomIO"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response when successfully modifying permissions."
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "400": {
+ "description": "Users are neither members nor collaborators of this organization."
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/access/selected_users": {
+ "post": {
+ "summary": "Add users to Codespaces access for an organization",
+ "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/set-codespaces-access-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "deprecated": true,
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_usernames": {
+ "type": "array",
+ "description": "The usernames of the organization members whose codespaces be billed to the organization.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "selected_usernames"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_usernames": [
+ "johnDoe",
+ "atomIO"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response when successfully modifying permissions."
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "400": {
+ "description": "Users are neither members nor collaborators of this organization."
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ },
+ "delete": {
+ "summary": "Remove users from Codespaces access for an organization",
+ "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-codespaces-access-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization"
+ },
+ "deprecated": true,
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_usernames": {
+ "type": "array",
+ "description": "The usernames of the organization members whose codespaces should not be billed to the organization.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "selected_usernames"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_usernames": [
+ "johnDoe",
+ "atomIO"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response when successfully modifying permissions."
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "400": {
+ "description": "Users are neither members nor collaborators of this organization."
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/secrets": {
+ "get": {
+ "summary": "List organization secrets",
+ "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-org-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespaces-org-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-codespaces-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/secrets/public-key": {
+ "get": {
+ "summary": "Get an organization public key",
+ "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-org-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get an organization secret",
+ "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-org-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-codespaces-secret"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update an organization secret",
+ "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-or-update-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "The ID of the key you used to encrypt the secret."
+ },
+ "visibility": {
+ "type": "string",
+ "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ]
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "visibility"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 1296269,
+ 1296280
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization secret",
+ "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": {
+ "get": {
+ "summary": "List selected repositories for an organization secret",
+ "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repository-paginated"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories for an organization secret",
+ "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/set-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ 64780797
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "description": "Conflict when visibility type not set to selected"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ }
+ },
+ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add selected repository to an organization secret",
+ "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/add-selected-repo-to-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when repository was added to the selected list"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "description": "Conflict when visibility type is not set to selected"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ },
+ "delete": {
+ "summary": "Remove selected repository from an organization secret",
+ "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/remove-selected-repo-from-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response when repository was removed from the selected list"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "description": "Conflict when visibility type not set to selected"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organization-secrets"
+ }
+ }
+ },
+ "/orgs/{org}/copilot/billing": {
+ "get": {
+ "summary": "Get Copilot seat information and settings for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/get-copilot-organization-details",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/copilot-organization-details"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/copilot-organization-details"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ }
+ },
+ "/orgs/{org}/copilot/billing/seats": {
+ "get": {
+ "summary": "List all Copilot seat assignments for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/list-copilot-seats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 50
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_seats": {
+ "type": "integer",
+ "description": "Total number of Copilot seats for the organization currently being billed."
+ },
+ "seats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/copilot-seat-details"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/copilot-seats-list"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ }
+ },
+ "/orgs/{org}/copilot/billing/selected_teams": {
+ "post": {
+ "summary": "Add teams to the Copilot subscription for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/add-copilot-seats-for-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_teams": {
+ "type": "array",
+ "description": "List of team names within the organization to which to grant access to GitHub Copilot.",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1
+ }
+ },
+ "required": [
+ "selected_teams"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_teams": [
+ "engteam1",
+ "engteam2",
+ "engteam3"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The total number of seat assignments created.",
+ "properties": {
+ "seats_created": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "seats_created"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats_created": 5
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ },
+ "delete": {
+ "summary": "Remove teams from the Copilot subscription for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/cancel-copilot-seat-assignment-for-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_teams": {
+ "type": "array",
+ "description": "The names of teams from which to revoke access to GitHub Copilot.",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1
+ }
+ },
+ "required": [
+ "selected_teams"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_teams": [
+ "engteam1",
+ "engteam2",
+ "engteam3"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The total number of seat assignments cancelled.",
+ "properties": {
+ "seats_cancelled": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "seats_cancelled"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats_cancelled": 5
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ }
+ },
+ "/orgs/{org}/copilot/billing/selected_users": {
+ "post": {
+ "summary": "Add users to the Copilot subscription for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/add-copilot-seats-for-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_usernames": {
+ "type": "array",
+ "description": "The usernames of the organization members to be granted access to GitHub Copilot.",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1
+ }
+ },
+ "required": [
+ "selected_usernames"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_usernames": [
+ "cooluser1",
+ "hacker2",
+ "octocat"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The total number of seat assignments created.",
+ "properties": {
+ "seats_created": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "seats_created"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats_created": 5
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ },
+ "delete": {
+ "summary": "Remove users from the Copilot subscription for an organization",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/cancel-copilot-seat-assignment-for-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_usernames": {
+ "type": "array",
+ "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1
+ }
+ },
+ "required": [
+ "selected_usernames"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_usernames": [
+ "cooluser1",
+ "hacker2",
+ "octocat"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The total number of seat assignments cancelled.",
+ "properties": {
+ "seats_cancelled": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "seats_cancelled"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats_cancelled": 5
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/alerts": {
+ "get": {
+ "summary": "List Dependabot alerts for an organization",
+ "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-alerts-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-states"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-scope"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-first"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-last"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/dependabot-alert-with-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-alerts-for-organization"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "alerts"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/secrets": {
+ "get": {
+ "summary": "List organization secrets",
+ "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-org-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-dependabot-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-dependabot-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/secrets/public-key": {
+ "get": {
+ "summary": "Get an organization public key",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/get-org-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependabot-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get an organization secret",
+ "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/get-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-dependabot-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-dependabot-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update an organization secret",
+ "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/create-or-update-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ },
+ "visibility": {
+ "type": "string",
+ "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ]
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "visibility"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ "1296269",
+ "1296280"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization secret",
+ "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/delete-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": {
+ "get": {
+ "summary": "List selected repositories for an organization secret",
+ "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repository-paginated"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories for an organization secret",
+ "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/set-selected-repos-for-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ 64780797
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add selected repository to an organization secret",
+ "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/add-selected-repo-to-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when repository was added to the selected list"
+ },
+ "409": {
+ "description": "Conflict when visibility type is not set to selected"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Remove selected repository from an organization secret",
+ "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/remove-selected-repo-from-org-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response when repository was removed from the selected list"
+ },
+ "409": {
+ "description": "Conflict when visibility type not set to selected"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/orgs/{org}/docker/conflicts": {
+ "get": {
+ "summary": "Get list of conflicting packages during Docker migration for organization",
+ "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-docker-migration-conflicting-packages-for-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-org"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/events": {
+ "get": {
+ "summary": "List public organization events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-org-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-public-organization-events"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "200-response": {
+ "$ref": "#/components/examples/public-org-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/orgs/{org}/failed_invitations": {
+ "get": {
+ "summary": "List failed organization invitations",
+ "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-failed-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/hooks": {
+ "get": {
+ "summary": "List organization webhooks",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-webhooks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/org-hook"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-hook-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create an organization webhook",
+ "description": "Here's how you can create a hook that posts payloads in JSON format:",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Must be passed as \"web\"."
+ },
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ },
+ "username": {
+ "type": "string",
+ "example": "\"kdaigle\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"password\""
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "default": true
+ }
+ },
+ "required": [
+ "name",
+ "config"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-hook"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/orgs/octocat/hooks/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get an organization webhook",
+ "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-hook"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update an organization webhook",
+ "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "default": true
+ },
+ "name": {
+ "type": "string",
+ "example": "\"web\""
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-hook-2"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization webhook",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/config": {
+ "get": {
+ "summary": "Get a webhook configuration for an organization",
+ "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-webhook-config-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a webhook configuration for an organization",
+ "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-webhook-config-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Update an existing webhook",
+ "value": {
+ "url": "http://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/deliveries": {
+ "get": {
+ "summary": "List deliveries for an organization webhook",
+ "description": "Returns a list of webhook deliveries for a webhook configured in an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-webhook-deliveries",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/cursor"
+ },
+ {
+ "name": "redelivery",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/hook-delivery-item"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery-items"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
+ "get": {
+ "summary": "Get a webhook delivery for an organization webhook",
+ "description": "Returns a delivery for a webhook configured in an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook-delivery"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
+ "post": {
+ "summary": "Redeliver a delivery for an organization webhook",
+ "description": "Redeliver a delivery for a webhook configured in an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/redeliver-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping an organization webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/installation": {
+ "get": {
+ "summary": "Get an organization installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-org-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/installation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/orgs/{org}/installations": {
+ "get": {
+ "summary": "List app installations for an organization",
+ "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-app-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "installations"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "installations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/installation"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/installation-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/interaction-limits": {
+ "get": {
+ "summary": "Get interaction restrictions for an organization",
+ "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/get-restrictions-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-response"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "orgs"
+ }
+ },
+ "put": {
+ "summary": "Set interaction restrictions for an organization",
+ "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/set-restrictions-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "limit": "collaborators_only",
+ "expiry": "one_month"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-response"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "orgs"
+ }
+ },
+ "delete": {
+ "summary": "Remove interaction restrictions for an organization",
+ "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/remove-restrictions-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/invitations": {
+ "get": {
+ "summary": "List pending organization invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-pending-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "role",
+ "description": "Filter invitations by their member role.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "admin",
+ "direct_member",
+ "billing_manager",
+ "hiring_manager"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "invitation_source",
+ "description": "Filter invitations by their invitation source.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "member",
+ "scim"
+ ],
+ "default": "all"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "post": {
+ "summary": "Create an organization invitation",
+ "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "invitee_id": {
+ "type": "integer",
+ "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting."
+ },
+ "email": {
+ "type": "string",
+ "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user."
+ },
+ "role": {
+ "type": "string",
+ "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.",
+ "enum": [
+ "admin",
+ "direct_member",
+ "billing_manager",
+ "reinstate"
+ ],
+ "default": "direct_member"
+ },
+ "team_ids": {
+ "type": "array",
+ "description": "Specify IDs for the teams you want to invite new members to.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "team_ids": [
+ 12,
+ 26
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-invitation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-invitation"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/invitations/{invitation_id}": {
+ "delete": {
+ "summary": "Cancel an organization invitation",
+ "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/cancel-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/invitations/{invitation_id}/teams": {
+ "get": {
+ "summary": "List organization invitation teams",
+ "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-invitation-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/issues": {
+ "get": {
+ "summary": "List organization issues assigned to the authenticated user",
+ "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "filter",
+ "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "assigned",
+ "created",
+ "mentioned",
+ "subscribed",
+ "repos",
+ "all"
+ ],
+ "default": "assigned"
+ }
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/labels"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-with-repo-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/orgs/{org}/members": {
+ "get": {
+ "summary": "List organization members",
+ "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-organization-members"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "filter",
+ "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "2fa_disabled",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "role",
+ "description": "Filter members returned by their role.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "admin",
+ "member"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/members/{username}": {
+ "get": {
+ "summary": "Check organization membership for a user",
+ "description": "Check if a user is, publicly or privately, a member of the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/check-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if requester is an organization member and user is a member"
+ },
+ "302": {
+ "description": "Response if requester is not an organization member",
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/orgs/github/public_members/pezra",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if requester is an organization member and user is not a member"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove an organization member",
+ "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-member",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/members/{username}/codespaces": {
+ "get": {
+ "summary": "List codespaces for a user in organization",
+ "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-codespaces-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "codespaces"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "codespaces": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-list"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/members/{username}/codespaces/{codespace_name}": {
+ "delete": {
+ "summary": "Delete a codespace from the organization",
+ "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-from-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": {
+ "post": {
+ "summary": "Stop a codespace for an organization user",
+ "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/stop-in-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "organizations"
+ }
+ }
+ },
+ "/orgs/{org}/members/{username}/copilot": {
+ "get": {
+ "summary": "Get Copilot seat assignment details for a user",
+ "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.",
+ "tags": [
+ "copilot"
+ ],
+ "operationId": "copilot/get-copilot-seat-details-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The user's GitHub Copilot seat details, including usage.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/copilot-seat-details"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/copilot-seat-detail-active"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "copilot",
+ "subcategory": "copilot-user-management"
+ }
+ }
+ },
+ "/orgs/{org}/memberships/{username}": {
+ "get": {
+ "summary": "Get organization membership for a user",
+ "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-membership"
+ },
+ "examples": {
+ "response-if-user-has-an-active-admin-membership-with-organization": {
+ "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Set organization membership for a user",
+ "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.",
+ "enum": [
+ "admin",
+ "member"
+ ],
+ "default": "member"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Set an organization membership role for a user",
+ "value": {
+ "role": "member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-membership"
+ },
+ "examples": {
+ "response-if-user-already-had-membership-with-organization": {
+ "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove organization membership for a user",
+ "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/migrations": {
+ "get": {
+ "summary": "List organization migrations",
+ "description": "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).\n\nA list of `repositories` is only returned for export migrations.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "exclude",
+ "description": "Exclude attributes from the API response to improve performance",
+ "in": "query",
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "Allowed values that can be passed to the exclude param.",
+ "enum": [
+ "repositories"
+ ],
+ "example": "repositories",
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/migration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration-with-short-org-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ },
+ "post": {
+ "summary": "Start an organization migration",
+ "description": "Initiates the generation of a migration archive.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/start-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repositories": {
+ "type": "array",
+ "description": "A list of arrays indicating which repositories should be migrated.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "lock_repositories": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.",
+ "default": false
+ },
+ "exclude_metadata": {
+ "type": "boolean",
+ "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.",
+ "default": false
+ },
+ "exclude_git_data": {
+ "type": "boolean",
+ "description": "Indicates whether the repository git data should be excluded from the migration.",
+ "default": false
+ },
+ "exclude_attachments": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).",
+ "default": false
+ },
+ "exclude_releases": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).",
+ "default": false
+ },
+ "exclude_owner_projects": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.",
+ "default": false
+ },
+ "org_metadata_only": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).",
+ "default": false
+ },
+ "exclude": {
+ "type": "array",
+ "description": "Exclude related items from being returned in the response in order to improve performance of the request.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "repositories"
+ ]
+ }
+ }
+ },
+ "required": [
+ "repositories"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/migration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration-with-short-org-2"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/migrations/{migration_id}": {
+ "get": {
+ "summary": "Get an organization migration status",
+ "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-status-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "name": "exclude",
+ "description": "Exclude attributes from the API response to improve performance",
+ "in": "query",
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "Allowed values that can be passed to the exclude param.",
+ "enum": [
+ "repositories"
+ ],
+ "example": "repositories",
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/migration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration-with-short-org"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/migrations/{migration_id}/archive": {
+ "get": {
+ "summary": "Download an organization migration archive",
+ "description": "Fetches the URL to a migration archive.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/download-archive-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/migration-id"
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization migration archive",
+ "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/delete-archive-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/migration-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": {
+ "delete": {
+ "summary": "Unlock an organization repository",
+ "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/unlock-repo-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "$ref": "#/components/parameters/repo-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/migrations/{migration_id}/repositories": {
+ "get": {
+ "summary": "List repositories in an organization migration",
+ "description": "List all the repositories for this organization migration.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/list-repos-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/orgs/{org}/organization-fine-grained-permissions": {
+ "get": {
+ "summary": "List organization fine-grained permissions for an organization",
+ "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-organization-fine-grained-permissions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-fine-grained-permission"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-fine-grained-permission-example"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles": {
+ "get": {
+ "summary": "Get all organization roles for an organization",
+ "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-org-roles",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response - list of organization roles",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer",
+ "description": "The total number of organization roles available to the organization."
+ },
+ "roles": {
+ "type": "array",
+ "description": "The list of organization roles available to the organization.",
+ "items": {
+ "$ref": "#/components/schemas/organization-role"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-role-list"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ },
+ "post": {
+ "summary": "Create a custom organization role",
+ "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-custom-organization-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the custom role."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description about the intended usage of this role or what permissions it grants."
+ },
+ "permissions": {
+ "type": "array",
+ "description": "A list of additional permissions included in this role.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "permissions"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Custom Role Manager",
+ "description": "Permissions to manage custom roles within an org",
+ "permissions": [
+ "write_organization_custom_repo_role",
+ "write_organization_custom_org_role",
+ "read_organization_custom_repo_role",
+ "read_organization_custom_org_role"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-role"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 8030,
+ "name": "Custom Role Manager",
+ "description": "Permissions to manage custom roles within an org",
+ "permissions": [
+ "write_organization_custom_repo_role",
+ "write_organization_custom_org_role",
+ "read_organization_custom_repo_role",
+ "read_organization_custom_org_role"
+ ],
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "created_at": "2022-07-04T22:19:11Z",
+ "updated_at": "2022-07-04T22:19:11Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/teams/{team_slug}": {
+ "delete": {
+ "summary": "Remove all organization roles for a team",
+ "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/revoke-all-org-roles-team",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": {
+ "put": {
+ "summary": "Assign an organization role to a team",
+ "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/assign-team-to-org-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "description": "Response if the organization, team or role does not exist."
+ },
+ "422": {
+ "description": "Response if the organization roles feature is not enabled for the organization, or validation failed."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ },
+ "delete": {
+ "summary": "Remove an organization role from a team",
+ "description": "Removes an organization role from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/revoke-org-role-team",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/users/{username}": {
+ "delete": {
+ "summary": "Remove all organization roles for a user",
+ "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/revoke-all-org-roles-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/users/{username}/{role_id}": {
+ "put": {
+ "summary": "Assign an organization role to a user",
+ "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/assign-user-to-org-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "description": "Response if the organization, user or role does not exist."
+ },
+ "422": {
+ "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ },
+ "delete": {
+ "summary": "Remove an organization role from a user",
+ "description": "Remove an organization role from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/revoke-org-role-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/{role_id}": {
+ "get": {
+ "summary": "Get an organization role",
+ "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-org-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-role"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-role"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ },
+ "patch": {
+ "summary": "Update a custom organization role",
+ "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/patch-custom-organization-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the custom role."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description about the intended usage of this role or what permissions it grants."
+ },
+ "permissions": {
+ "type": "array",
+ "description": "A list of additional permissions included in this role.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "description": "Permissions to manage custom roles within an org."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/organization-role"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 8030,
+ "name": "Custom Role Manager",
+ "description": "Permissions to manage custom roles within an org",
+ "permissions": [
+ "write_organization_custom_repo_role",
+ "write_organization_custom_org_role",
+ "read_organization_custom_repo_role",
+ "read_organization_custom_org_role"
+ ],
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "created_at": "2022-07-04T22:19:11Z",
+ "updated_at": "2022-07-04T22:19:11Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ },
+ "delete": {
+ "summary": "Delete a custom organization role.",
+ "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/delete-custom-organization-role",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/{role_id}/teams": {
+ "get": {
+ "summary": "List teams that are assigned to an organization role",
+ "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-org-role-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response - List of assigned teams",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of teams assigned to the organization role",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "description": "Response if the organization or role does not exist."
+ },
+ "422": {
+ "description": "Response if the organization roles feature is not enabled or validation failed."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/organization-roles/{role_id}/users": {
+ "get": {
+ "summary": "List users that are assigned to an organization role",
+ "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-org-role-users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/role-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response - List of assigned users",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of users assigned to the organization role",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "description": "Response if the organization or role does not exist."
+ },
+ "422": {
+ "description": "Response if the organization roles feature is not enabled or validation failed."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "organization-roles"
+ }
+ }
+ },
+ "/orgs/{org}/outside_collaborators": {
+ "get": {
+ "summary": "List outside collaborators for an organization",
+ "description": "List all users who are outside collaborators of an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-outside-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "filter",
+ "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "2fa_disabled",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ }
+ }
+ },
+ "/orgs/{org}/outside_collaborators/{username}": {
+ "put": {
+ "summary": "Convert an organization member to outside collaborator",
+ "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/convert-member-to-outside-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "async": {
+ "type": "boolean",
+ "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.",
+ "default": false
+ }
+ }
+ },
+ "examples": {
+ "202": {
+ "summary": "Status code 202, asynchronous request",
+ "value": {
+ "async": true
+ }
+ },
+ "204": {
+ "summary": "Status code 204, synchronous request",
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "User is getting converted asynchronously",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "202": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "User was converted"
+ },
+ "403": {
+ "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\""
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ }
+ },
+ "delete": {
+ "summary": "Remove outside collaborator from an organization",
+ "description": "Removing a user from this list will remove them from all the organization's repositories.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-outside-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "description": "Unprocessable Entity if user is a member of the organization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-user-is-a-member-of-the-organization": {
+ "value": {
+ "message": "You cannot specify an organization member to remove as an outside collaborator.",
+ "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ }
+ }
+ },
+ "/orgs/{org}/packages": {
+ "get": {
+ "summary": "List packages for an organization",
+ "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-packages-for-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "package_type",
+ "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/package-visibility"
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-org"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "400": {
+ "$ref": "#/components/responses/package_es_list_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/packages/{package_type}/{package_name}": {
+ "get": {
+ "summary": "Get a package for an organization",
+ "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-for-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-org"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a package for an organization",
+ "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/packages/{package_type}/{package_name}/restore": {
+ "post": {
+ "summary": "Restore a package for an organization",
+ "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "token",
+ "description": "package token",
+ "schema": {
+ "type": "string"
+ },
+ "required": false,
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
+ "get": {
+ "summary": "List package versions for a package owned by an organization",
+ "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-all-package-versions-for-package-owned-by-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "required": false,
+ "description": "The state of the package, either active or deleted.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "active",
+ "deleted"
+ ],
+ "default": "active"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package-version"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-versions-for-org"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": {
+ "get": {
+ "summary": "Get a package version for an organization",
+ "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-version-for-organization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package-version"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-version-org"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete package version for an organization",
+ "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-version-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
+ "post": {
+ "summary": "Restore package version for an organization",
+ "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-version-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-token-requests": {
+ "get": {
+ "summary": "List requests to access organization resources with fine-grained personal access tokens",
+ "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-pat-grant-requests",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-owner"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-repository"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-permission"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-before"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-after"
+ }
+ ],
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-programmatic-access-grant-request"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-pat-grant-request-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ },
+ "post": {
+ "summary": "Review requests to access organization resources with fine-grained personal access tokens",
+ "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/review-pat-grant-requests-in-bulk",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "pat_request_ids": {
+ "type": "array",
+ "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.",
+ "items": {
+ "type": "integer"
+ },
+ "minItems": 1,
+ "maxItems": 100
+ },
+ "action": {
+ "type": "string",
+ "description": "Action to apply to the requests.",
+ "enum": [
+ "approve",
+ "deny"
+ ]
+ },
+ "reason": {
+ "type": "string",
+ "description": "Reason for approving or denying the requests. Max 1024 characters.",
+ "maxLength": 1024,
+ "nullable": true
+ }
+ },
+ "required": [
+ "action"
+ ]
+ },
+ "examples": {
+ "204": {
+ "summary": "Example of denying a request",
+ "value": {
+ "pat_request_ids": [
+ 42,
+ 73
+ ],
+ "action": "deny",
+ "reason": "Access is too broad."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-token-requests/{pat_request_id}": {
+ "post": {
+ "summary": "Review a request to access organization resources with a fine-grained personal access token",
+ "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/review-pat-grant-request",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "pat_request_id",
+ "in": "path",
+ "description": "Unique identifier of the request for access via fine-grained personal access token.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "description": "Action to apply to the request.",
+ "enum": [
+ "approve",
+ "deny"
+ ]
+ },
+ "reason": {
+ "type": "string",
+ "description": "Reason for approving or denying the request. Max 1024 characters.",
+ "maxLength": 1024,
+ "nullable": true
+ }
+ },
+ "required": [
+ "action"
+ ]
+ },
+ "examples": {
+ "204": {
+ "summary": "Example of denying a request",
+ "value": {
+ "action": "deny",
+ "reason": "This request is denied because the access is too broad."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": {
+ "get": {
+ "summary": "List repositories requested to be accessed by a fine-grained personal access token",
+ "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-pat-grant-request-repositories",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "pat_request_id",
+ "in": "path",
+ "description": "Unique identifier of the request for access via fine-grained personal access token.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-tokens": {
+ "get": {
+ "summary": "List fine-grained personal access tokens with access to organization resources",
+ "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-pat-grants",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-owner"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-repository"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-permission"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-before"
+ },
+ {
+ "$ref": "#/components/parameters/personal-access-token-after"
+ }
+ ],
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-programmatic-access-grant"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-pat-grant-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ },
+ "post": {
+ "summary": "Update the access to organization resources via fine-grained personal access tokens",
+ "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-pat-accesses",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "description": "Action to apply to the fine-grained personal access token.",
+ "enum": [
+ "revoke"
+ ]
+ },
+ "pat_ids": {
+ "description": "The IDs of the fine-grained personal access tokens.",
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "Unique identifier of the fine-grained personal access token."
+ },
+ "minItems": 1,
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "action",
+ "pat_ids"
+ ]
+ },
+ "examples": {
+ "204": {
+ "summary": "Example of revoking a fine-grained personal access token.",
+ "value": {
+ "action": "revoke",
+ "pat_ids": [
+ 1296269,
+ 1296280
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-tokens/{pat_id}": {
+ "post": {
+ "summary": "Update the access a fine-grained personal access token has to organization resources",
+ "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-pat-access",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/fine-grained-personal-access-token-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "description": "Action to apply to the fine-grained personal access token.",
+ "enum": [
+ "revoke"
+ ]
+ }
+ },
+ "required": [
+ "action"
+ ]
+ },
+ "examples": {
+ "204": {
+ "summary": "Example of revoking a fine-grained personal access token.",
+ "value": {
+ "action": "revoke"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": {
+ "get": {
+ "summary": "List repositories a fine-grained personal access token has access to",
+ "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-pat-grant-repositories",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "pat_id",
+ "in": "path",
+ "description": "Unique identifier of the fine-grained personal access token.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "personal-access-tokens"
+ }
+ }
+ },
+ "/orgs/{org}/projects": {
+ "get": {
+ "summary": "List organization projects",
+ "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#list-organization-projects"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the projects to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ },
+ "post": {
+ "summary": "Create an organization project",
+ "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#create-an-organization-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the project."
+ },
+ "body": {
+ "type": "string",
+ "description": "The description of the project."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-2"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ }
+ },
+ "/orgs/{org}/properties/schema": {
+ "get": {
+ "summary": "Get all custom properties for an organization",
+ "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-all-custom-properties",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/org-custom-property"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-custom-properties"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ },
+ "patch": {
+ "summary": "Create or update custom properties for an organization",
+ "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-or-update-custom-properties",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "type": "array",
+ "description": "The array of custom properties to create or update.",
+ "items": {
+ "$ref": "#/components/schemas/org-custom-property"
+ },
+ "minItems": 1,
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "properties"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "properties": [
+ {
+ "property_name": "environment",
+ "value_type": "single_select",
+ "required": true,
+ "default_value": "production",
+ "description": "Prod or dev environment",
+ "allowed_values": [
+ "production",
+ "development"
+ ],
+ "values_editable_by": "org_actors"
+ },
+ {
+ "property_name": "service",
+ "value_type": "string"
+ },
+ {
+ "property_name": "team",
+ "value_type": "string",
+ "description": "Team owning the repository"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/org-custom-property"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-custom-properties"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ }
+ },
+ "/orgs/{org}/properties/schema/{custom_property_name}": {
+ "get": {
+ "summary": "Get a custom property for an organization",
+ "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-custom-property",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/custom-property-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-custom-property"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-custom-property"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ },
+ "put": {
+ "summary": "Create or update a custom property for an organization",
+ "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-or-update-custom-property",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/custom-property-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value_type": {
+ "type": "string",
+ "example": "single_select",
+ "enum": [
+ "string",
+ "single_select"
+ ],
+ "description": "The type of the value for the property"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Whether the property is required."
+ },
+ "default_value": {
+ "type": "string",
+ "nullable": true,
+ "description": "Default value of the property"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true,
+ "description": "Short description of the property"
+ },
+ "allowed_values": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 75
+ },
+ "maxItems": 200,
+ "nullable": true,
+ "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
+ }
+ },
+ "required": [
+ "value_type"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "value_type": "single_select",
+ "required": true,
+ "default_value": "production",
+ "description": "Prod or dev environment",
+ "allowed_values": [
+ "production",
+ "development"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-custom-property"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-custom-property"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ },
+ "delete": {
+ "summary": "Remove a custom property for an organization",
+ "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-custom-property",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/custom-property-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ }
+ },
+ "/orgs/{org}/properties/values": {
+ "get": {
+ "summary": "List custom property values for organization repositories",
+ "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-custom-properties-values-for-repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "repository_query",
+ "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/org-repo-custom-property-values"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-repo-custom-property-values"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ },
+ "patch": {
+ "summary": "Create or update custom property values for organization repositories",
+ "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-or-update-custom-properties-values-for-repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repository_names": {
+ "type": "array",
+ "description": "The names of repositories that the custom property values will be applied to.",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1,
+ "maxItems": 30
+ },
+ "properties": {
+ "type": "array",
+ "description": "List of custom property names and associated values to apply to the repositories.",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ }
+ }
+ },
+ "required": [
+ "repository_names",
+ "properties"
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-repo-update-custom-property-values"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "No Content when custom property values are successfully created or updated"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "custom-properties"
+ }
+ }
+ },
+ "/orgs/{org}/public_members": {
+ "get": {
+ "summary": "List public organization members",
+ "description": "Members of an organization can choose to have their membership publicized or not.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-public-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/public_members/{username}": {
+ "get": {
+ "summary": "Check public organization membership for a user",
+ "description": "Check if the provided user is a public member of the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/check-public-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if user is a public member"
+ },
+ "404": {
+ "description": "Not Found if user is not a public member"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Set public organization membership for the authenticated user",
+ "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-public-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove public organization membership for the authenticated user",
+ "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-public-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/repos": {
+ "get": {
+ "summary": "List organization repositories",
+ "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "type",
+ "description": "Specifies the types of repositories you want returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "public",
+ "private",
+ "forks",
+ "sources",
+ "member"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "post": {
+ "summary": "Create an organization repository",
+ "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the repository."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the repository."
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Whether the repository is private.",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "description": "The visibility of the repository.",
+ "enum": [
+ "public",
+ "private"
+ ]
+ },
+ "has_issues": {
+ "type": "boolean",
+ "description": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "default": true
+ },
+ "has_projects": {
+ "type": "boolean",
+ "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.",
+ "default": true
+ },
+ "has_wiki": {
+ "type": "boolean",
+ "description": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "default": true
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "is_template": {
+ "type": "boolean",
+ "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "default": false
+ },
+ "team_id": {
+ "type": "integer",
+ "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization."
+ },
+ "auto_init": {
+ "type": "boolean",
+ "description": "Pass `true` to create an initial commit with empty README.",
+ "default": false
+ },
+ "gitignore_template": {
+ "type": "string",
+ "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"."
+ },
+ "license_template": {
+ "type": "string",
+ "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"."
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "default": true
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "default": true
+ },
+ "allow_auto_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.",
+ "default": false
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**",
+ "default": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/orgs/{org}/rulesets": {
+ "get": {
+ "summary": "Get all organization repository rulesets",
+ "description": "Get all the repository rulesets for an organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-org-rulesets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-ruleset-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "post": {
+ "summary": "Create an organization repository ruleset",
+ "description": "Create a repository ruleset for an organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-org-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "description": "Request body",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the ruleset."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the ruleset.",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ },
+ "enforcement": {
+ "$ref": "#/components/schemas/repository-rule-enforcement"
+ },
+ "bypass_actors": {
+ "type": "array",
+ "description": "The actors that can bypass the rules in this ruleset",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
+ }
+ },
+ "conditions": {
+ "$ref": "#/components/schemas/org-ruleset-conditions"
+ },
+ "rules": {
+ "type": "array",
+ "description": "An array of rules within the ruleset.",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "enforcement"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "super cool ruleset",
+ "target": "branch",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ },
+ "repository_name": {
+ "include": [
+ "important_repository",
+ "another_important_repository"
+ ],
+ "exclude": [
+ "unimportant_repository"
+ ],
+ "protected": true
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ }
+ },
+ "/orgs/{org}/rulesets/rule-suites": {
+ "get": {
+ "summary": "List organization rule suites",
+ "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-org-rule-suites",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/repository-name-in-query"
+ },
+ {
+ "$ref": "#/components/parameters/time-period"
+ },
+ {
+ "$ref": "#/components/parameters/actor-name-in-query"
+ },
+ {
+ "$ref": "#/components/parameters/rule-suite-result"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/rule-suites"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/rule-suite-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rule-suites"
+ }
+ }
+ },
+ "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": {
+ "get": {
+ "summary": "Get an organization rule suite",
+ "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-org-rule-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/rule-suite-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/rule-suite"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/rule-suite"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rule-suites"
+ }
+ }
+ },
+ "/orgs/{org}/rulesets/{ruleset_id}": {
+ "get": {
+ "summary": "Get an organization repository ruleset",
+ "description": "Get a repository ruleset for an organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-org-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "put": {
+ "summary": "Update an organization repository ruleset",
+ "description": "Update a ruleset for an organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-org-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Request body",
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the ruleset."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the ruleset.",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ },
+ "enforcement": {
+ "$ref": "#/components/schemas/repository-rule-enforcement"
+ },
+ "bypass_actors": {
+ "type": "array",
+ "description": "The actors that can bypass the rules in this ruleset",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
+ }
+ },
+ "conditions": {
+ "$ref": "#/components/schemas/org-ruleset-conditions"
+ },
+ "rules": {
+ "description": "An array of rules within the ruleset.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "super cool ruleset",
+ "target": "branch",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ },
+ "repository_name": {
+ "include": [
+ "important_repository",
+ "another_important_repository"
+ ],
+ "exclude": [
+ "unimportant_repository"
+ ],
+ "protected": true
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization repository ruleset",
+ "description": "Delete a ruleset for an organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-org-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ }
+ },
+ "/orgs/{org}/secret-scanning/alerts": {
+ "get": {
+ "summary": "List secret scanning alerts for an organization",
+ "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "secret-scanning"
+ ],
+ "operationId": "secret-scanning/list-alerts-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-state"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-secret-type"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-resolution"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-validity"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-secret-scanning-alert"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-secret-scanning-alert-list"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ }
+ },
+ "/orgs/{org}/security-advisories": {
+ "get": {
+ "summary": "List repository security advisories for an organization",
+ "description": "Lists repository security advisories for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/list-org-repository-advisories",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "published"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "name": "per_page",
+ "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ {
+ "name": "state",
+ "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "triage",
+ "draft",
+ "published",
+ "closed"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-advisory"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/list-repository-advisories"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/orgs/{org}/security-managers": {
+ "get": {
+ "summary": "List security manager teams",
+ "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-security-manager-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "security-managers"
+ }
+ }
+ },
+ "/orgs/{org}/security-managers/teams/{team_slug}": {
+ "put": {
+ "summary": "Add a security manager team",
+ "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/add-security-manager-team",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "description": "The organization has reached the maximum number of security manager teams."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "security-managers"
+ }
+ },
+ "delete": {
+ "summary": "Remove a security manager team",
+ "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-security-manager-team",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "security-managers"
+ }
+ }
+ },
+ "/orgs/{org}/settings/billing/actions": {
+ "get": {
+ "summary": "Get GitHub Actions billing for an organization",
+ "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.",
+ "operationId": "billing/get-github-actions-billing-org",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/orgs/{org}/settings/billing/packages": {
+ "get": {
+ "summary": "Get GitHub Packages billing for an organization",
+ "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.",
+ "operationId": "billing/get-github-packages-billing-org",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/packages-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/orgs/{org}/settings/billing/shared-storage": {
+ "get": {
+ "summary": "Get shared storage billing for an organization",
+ "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.",
+ "operationId": "billing/get-shared-storage-billing-org",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/combined-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/combined-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/orgs/{org}/teams": {
+ "get": {
+ "summary": "List teams",
+ "description": "Lists all teams in an organization that are visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-teams"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "post": {
+ "summary": "Create a team",
+ "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#create-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the team."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team."
+ },
+ "maintainers": {
+ "type": "array",
+ "description": "List GitHub IDs for organization members who will become team maintainers.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "repo_names": {
+ "type": "array",
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "notification_setting": "notifications_enabled",
+ "privacy": "closed"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}": {
+ "get": {
+ "summary": "Get a team by name",
+ "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-by-name",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "patch": {
+ "summary": "Update a team",
+ "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#update-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the team."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team."
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response when the updated information already exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "delete": {
+ "summary": "Delete a team",
+ "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#delete-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions": {
+ "get": {
+ "summary": "List discussions",
+ "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-discussions-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#list-discussions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "pinned",
+ "in": "query",
+ "required": false,
+ "description": "Pinned discussions only filter",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-discussion"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ },
+ "post": {
+ "summary": "Create a discussion",
+ "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
+ "get": {
+ "summary": "Get a discussion",
+ "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ },
+ "patch": {
+ "summary": "Update a discussion",
+ "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ },
+ "delete": {
+ "summary": "Delete a discussion",
+ "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "get": {
+ "summary": "List discussion comments",
+ "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-discussion-comments-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ },
+ "post": {
+ "summary": "Create a discussion comment",
+ "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The discussion comment's body text."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "get": {
+ "summary": "Get a discussion comment",
+ "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ },
+ "patch": {
+ "summary": "Update a discussion comment",
+ "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The discussion comment's body text."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a discussion comment",
+ "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion comment",
+ "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-team-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion comment",
+ "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-team-discussion-comment-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response when the reaction type has already been added to this team discussion comment",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete team discussion comment reaction",
+ "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-team-discussion-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion",
+ "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-team-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion",
+ "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-team-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete team discussion reaction",
+ "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-team-discussion",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/invitations": {
+ "get": {
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-members-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#list-team-members"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-membership"
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-membership"
+ },
+ "examples": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "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.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects": {
+ "get": {
+ "summary": "List team projects",
+ "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-projects-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-team-projects"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-project"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-project-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "get": {
+ "summary": "Check team permissions for a project",
+ "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-project-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-project"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if project is not managed by this team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "put": {
+ "summary": "Add or update team project permissions",
+ "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-project-permissions-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ },
+ "nullable": true
+ },
+ "examples": {
+ "default": {
+ "summary": "Updates the permissions for the team to write for the project",
+ "value": {
+ "permission": "write"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if the project is not owned by the organization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
+ "value": {
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "delete": {
+ "summary": "Remove a project from a team",
+ "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-project-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/repos": {
+ "get": {
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-repos-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-team-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
+ "get": {
+ "summary": "Check team permissions for a repository",
+ "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-repo-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Alternative response with repository permissions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-repository"
+ },
+ "examples": {
+ "alternative-response-with-repository-permissions": {
+ "$ref": "#/components/examples/team-repository-alternative-response-with-repository-permissions"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
+ },
+ "404": {
+ "description": "Not Found if team does not have permission for the repository"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "put": {
+ "summary": "Add or update team repository permissions",
+ "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-repo-permissions-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
+ "default": "push"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Adding a team to an organization repository with the write role",
+ "value": {
+ "permission": "push"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ },
+ "delete": {
+ "summary": "Remove a repository from a team",
+ "description": "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. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-repo-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/teams": {
+ "get": {
+ "summary": "List child teams",
+ "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-child-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-child-teams"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/team-slug"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "if child teams exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "response-if-child-teams-exist": {
+ "$ref": "#/components/examples/team-items-response-if-child-teams-exist"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/orgs/{org}/{security_product}/{enablement}": {
+ "post": {
+ "summary": "Enable or disable a security feature for an organization",
+ "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/security-product"
+ },
+ {
+ "$ref": "#/components/parameters/org-security-product-enablement"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "query_suite": {
+ "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.",
+ "type": "string",
+ "enum": [
+ "default",
+ "extended"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Action started"
+ },
+ "422": {
+ "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/projects/columns/cards/{card_id}": {
+ "get": {
+ "summary": "Get a project card",
+ "description": "Gets information about a project card.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#get-a-project-card"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/card-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-card"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-card"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ },
+ "patch": {
+ "summary": "Update an existing project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/update-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#update-an-existing-project-card"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/card-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "description": "The project card's note",
+ "example": "Update all gems",
+ "type": "string",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Change the note on the card",
+ "value": {
+ "note": "Add payload for delete Project column"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-card"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-card"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ },
+ "delete": {
+ "summary": "Delete a project card",
+ "description": "Deletes a project card",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#delete-a-project-card"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/card-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ }
+ },
+ "/projects/columns/cards/{card_id}/moves": {
+ "post": {
+ "summary": "Move a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/move-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#move-a-project-card"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/card-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.",
+ "example": "bottom",
+ "type": "string",
+ "pattern": "^(?:top|bottom|after:\\d+)$"
+ },
+ "column_id": {
+ "description": "The unique identifier of the column the card should be moved to",
+ "example": 42,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Move the card to the bottom of the column",
+ "value": {
+ "column_id": 42,
+ "position": "bottom"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "503": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ }
+ },
+ "/projects/columns/{column_id}": {
+ "get": {
+ "summary": "Get a project column",
+ "description": "Gets information about a project column.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#get-a-project-column"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-column"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-column"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ },
+ "patch": {
+ "summary": "Update an existing project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/update-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#update-an-existing-project-column"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Rename the project column",
+ "value": {
+ "name": "To Do"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-column"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-column"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a project column",
+ "description": "Deletes a project column.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#delete-a-project-column"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ }
+ },
+ "/projects/columns/{column_id}/cards": {
+ "get": {
+ "summary": "List project cards",
+ "description": "Lists the project cards in a project.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-cards",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#list-project-cards"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ },
+ {
+ "name": "archived_state",
+ "description": "Filters the project cards that are returned by the card's state.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "archived",
+ "not_archived"
+ ],
+ "default": "not_archived"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-card"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-card-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ },
+ "post": {
+ "summary": "Create a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/cards#create-a-project-card"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "note": {
+ "description": "The project card's note",
+ "example": "Update all gems",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "note"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "content_id": {
+ "description": "The unique identifier of the content associated with the card",
+ "example": 42,
+ "type": "integer"
+ },
+ "content_type": {
+ "description": "The piece of content associated with the card",
+ "example": "PullRequest",
+ "type": "string"
+ }
+ },
+ "required": [
+ "content_id",
+ "content_type"
+ ]
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Create a new card",
+ "value": {
+ "note": "Add payload for delete Project column"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-card"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-card"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "description": "Validation failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/validation-error"
+ },
+ {
+ "$ref": "#/components/schemas/validation-error-simple"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ }
+ },
+ "/projects/columns/{column_id}/moves": {
+ "post": {
+ "summary": "Move a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/move-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#move-a-project-column"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/column-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.",
+ "example": "last",
+ "type": "string",
+ "pattern": "^(?:first|last|after:\\d+)$"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Move the column to the end of the board",
+ "value": {
+ "position": "last"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ }
+ },
+ "/projects/{project_id}": {
+ "get": {
+ "summary": "Get a project",
+ "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#get-a-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-3"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ },
+ "patch": {
+ "summary": "Update a project",
+ "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "operationId": "projects/update",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#update-a-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Name of the project",
+ "example": "Week One Sprint",
+ "type": "string"
+ },
+ "body": {
+ "description": "Body of the project",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string",
+ "nullable": true
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "example": "open",
+ "type": "string"
+ },
+ "organization_permission": {
+ "description": "The baseline permission that all organization members have on this project",
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ]
+ },
+ "private": {
+ "description": "Whether or not this project can be seen by everyone.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Change the name, state, and permissions for a project",
+ "value": {
+ "name": "Week One Sprint",
+ "state": "open",
+ "organization_permission": "write"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-3"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if the authenticated user does not have access to the project"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ },
+ "delete": {
+ "summary": "Delete a project",
+ "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.",
+ "operationId": "projects/delete",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#delete-a-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Delete Success"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ }
+ },
+ "/projects/{project_id}/collaborators": {
+ "get": {
+ "summary": "List project collaborators",
+ "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/collaborators#list-project-collaborators"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ },
+ {
+ "name": "affiliation",
+ "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "outside",
+ "direct",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/projects/{project_id}/collaborators/{username}": {
+ "put": {
+ "summary": "Add project collaborator",
+ "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/add-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/collaborators#add-project-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "description": "The permission to grant the collaborator.",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "default": "write",
+ "example": "write",
+ "type": "string"
+ }
+ },
+ "nullable": true
+ },
+ "examples": {
+ "default": {
+ "summary": "Applying write permissions for the new collaborator",
+ "value": {
+ "permission": "write"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "collaborators"
+ }
+ },
+ "delete": {
+ "summary": "Remove user as a collaborator",
+ "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/remove-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/projects/{project_id}/collaborators/{username}/permission": {
+ "get": {
+ "summary": "Get project permission for a user",
+ "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-permission-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-collaborator-permission"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-collaborator-permission"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/projects/{project_id}/columns": {
+ "get": {
+ "summary": "List project columns",
+ "description": "Lists the project columns in a project.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-columns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#list-project-columns"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-column"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-column-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ },
+ "post": {
+ "summary": "Create a project column",
+ "description": "Creates a new project column.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/columns#create-a-project-column"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Remaining tasks"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project-column"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/projects/columns/367",
+ "project_url": "https://api.github.com/projects/120",
+ "cards_url": "https://api.github.com/projects/columns/367/cards",
+ "id": 367,
+ "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
+ "name": "To Do",
+ "created_at": "2016-09-05T14:18:44Z",
+ "updated_at": "2016-09-05T14:22:28Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ }
+ },
+ "/rate_limit": {
+ "get": {
+ "summary": "Get rate limit status for the authenticated user",
+ "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+ "tags": [
+ "rate-limit"
+ ],
+ "operationId": "rate-limit/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/rate-limit-overview"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/rate-limit-overview"
+ }
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/x-rate-limit-limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/x-rate-limit-remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/x-rate-limit-reset"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "rate-limit",
+ "subcategory": "rate-limit"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}": {
+ "get": {
+ "summary": "Get a repository",
+ "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#get-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/full-repository-default-response"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "patch": {
+ "summary": "Update a repository",
+ "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#update-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the repository."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the repository."
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "description": "The visibility of the repository.",
+ "enum": [
+ "public",
+ "private"
+ ]
+ },
+ "security_and_analysis": {
+ "type": "object",
+ "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, 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 \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.",
+ "nullable": true,
+ "properties": {
+ "advanced_security": {
+ "type": "object",
+ "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Can be `enabled` or `disabled`."
+ }
+ }
+ },
+ "secret_scanning": {
+ "type": "object",
+ "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Can be `enabled` or `disabled`."
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Can be `enabled` or `disabled`."
+ }
+ }
+ }
+ }
+ },
+ "has_issues": {
+ "type": "boolean",
+ "description": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "default": true
+ },
+ "has_projects": {
+ "type": "boolean",
+ "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.",
+ "default": true
+ },
+ "has_wiki": {
+ "type": "boolean",
+ "description": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "default": true
+ },
+ "is_template": {
+ "type": "boolean",
+ "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "default": false
+ },
+ "default_branch": {
+ "type": "string",
+ "description": "Updates the default branch for this repository."
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "default": true
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "default": true
+ },
+ "allow_auto_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.",
+ "default": false
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean",
+ "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.",
+ "default": false
+ },
+ "allow_update_branch": {
+ "type": "boolean",
+ "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.",
+ "default": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "archived": {
+ "type": "boolean",
+ "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.",
+ "default": false
+ },
+ "allow_forking": {
+ "type": "boolean",
+ "description": "Either `true` to allow private forks, or `false` to prevent private forks.",
+ "default": false
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.",
+ "default": false
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": true,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ }
+ },
+ "307": {
+ "$ref": "#/components/responses/temporary_redirect"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository",
+ "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#delete-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "Organization members cannot delete repositories.",
+ "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository"
+ }
+ }
+ }
+ }
+ }
+ },
+ "307": {
+ "$ref": "#/components/responses/temporary_redirect"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/artifacts": {
+ "get": {
+ "summary": "List artifacts for a repository",
+ "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-artifacts-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/artifact-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "artifacts"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "artifacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/artifact"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/artifact-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "artifacts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": {
+ "get": {
+ "summary": "Get an artifact",
+ "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-artifact",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/artifact-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/artifact"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/artifact"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "artifacts"
+ }
+ },
+ "delete": {
+ "summary": "Delete an artifact",
+ "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-artifact",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/artifact-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "artifacts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": {
+ "get": {
+ "summary": "Download an artifact",
+ "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/download-artifact",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/artifact-id"
+ },
+ {
+ "name": "archive_format",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "$ref": "#/components/headers/location"
+ }
+ }
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "artifacts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/cache/usage": {
+ "get": {
+ "summary": "Get GitHub Actions cache usage for a repository",
+ "description": "Gets GitHub Actions cache usage for a repository.\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.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-actions-cache-usage",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-cache-usage-by-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-cache-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/caches": {
+ "get": {
+ "summary": "List GitHub Actions caches for a repository",
+ "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-actions-cache-list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/actions-cache-git-ref-full"
+ },
+ {
+ "$ref": "#/components/parameters/actions-cache-key"
+ },
+ {
+ "$ref": "#/components/parameters/actions-cache-list-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-cache-list"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-cache-list"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ },
+ "delete": {
+ "summary": "Delete GitHub Actions caches for a repository (using a cache key)",
+ "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-actions-cache-by-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/actions-cache-key-required"
+ },
+ {
+ "$ref": "#/components/parameters/actions-cache-git-ref-full"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-cache-list"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-cache-list"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/caches/{cache_id}": {
+ "delete": {
+ "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)",
+ "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-actions-cache-by-id",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/cache-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "cache"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/jobs/{job_id}": {
+ "get": {
+ "summary": "Get a job for a workflow run",
+ "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-job-for-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/job-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/job"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/job"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-jobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": {
+ "get": {
+ "summary": "Download job logs for a workflow run",
+ "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/download-job-logs-for-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/job-id"
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-jobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
+ "post": {
+ "summary": "Re-run a job from a workflow run",
+ "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/re-run-job-for-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/job-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enable_debug_logging": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to enable debug logging for the re-run."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/oidc/customization/sub": {
+ "get": {
+ "summary": "Get the customization template for an OIDC subject claim for a repository",
+ "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-custom-oidc-sub-claim-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Status response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/oidc-custom-sub-repo"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/oidc-custom-sub-repo"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "oidc"
+ }
+ },
+ "put": {
+ "summary": "Set the customization template for an OIDC subject claim for a repository",
+ "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-custom-oidc-sub-claim-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Actions OIDC subject customization for a repository",
+ "description": "Actions OIDC subject customization for a repository",
+ "type": "object",
+ "required": [
+ "use_default"
+ ],
+ "properties": {
+ "use_default": {
+ "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.",
+ "type": "boolean"
+ },
+ "include_claim_keys": {
+ "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "use_default": false,
+ "include_claim_keys": [
+ "repo",
+ "context"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Empty response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "oidc"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/organization-secrets": {
+ "get": {
+ "summary": "List repository organization secrets",
+ "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-repo-organization-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/organization-variables": {
+ "get": {
+ "summary": "List repository organization variables",
+ "description": "Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-repo-organization-variables",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/variables-per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "variables"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "variables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-variable"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-variables-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/permissions": {
+ "get": {
+ "summary": "Get GitHub Actions permissions for a repository",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/get-github-actions-permissions-repository",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-repository-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-repository-permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set GitHub Actions permissions for a repository",
+ "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/set-github-actions-permissions-repository",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "$ref": "#/components/schemas/actions-enabled"
+ },
+ "allowed_actions": {
+ "$ref": "#/components/schemas/allowed-actions"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "enabled": true,
+ "allowed_actions": "selected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/permissions/access": {
+ "get": {
+ "summary": "Get the level of access for workflows outside of the repository",
+ "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow-access-to-repository",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-workflow-access-to-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-workflow-access-to-repository"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set the level of access for workflows outside of the repository",
+ "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-workflow-access-to-repository",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-workflow-access-to-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-workflow-access-to-repository"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/permissions/selected-actions": {
+ "get": {
+ "summary": "Get allowed actions and reusable workflows for a repository",
+ "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/get-allowed-actions-repository",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/selected-actions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/selected-actions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set allowed actions and reusable workflows for a repository",
+ "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/set-allowed-actions-repository",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/selected-actions"
+ },
+ "examples": {
+ "selected_actions": {
+ "$ref": "#/components/examples/selected-actions"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/permissions/workflow": {
+ "get": {
+ "summary": "Get default workflow permissions for a repository",
+ "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-github-actions-default-workflow-permissions-repository",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-get-default-workflow-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-default-workflow-permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ },
+ "put": {
+ "summary": "Set default workflow permissions for a repository",
+ "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-github-actions-default-workflow-permissions-repository",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success response"
+ },
+ "409": {
+ "description": "Conflict response when changing a setting is prevented by the owning organization"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-set-default-workflow-permissions"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-default-workflow-permissions"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "permissions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners": {
+ "get": {
+ "summary": "List self-hosted runners for a repository",
+ "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-self-hosted-runners-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "name",
+ "description": "The name of a self-hosted runner.",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "runners"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "runners": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/downloads": {
+ "get": {
+ "summary": "List runner applications for a repository",
+ "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-runner-applications-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner-application"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-application-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
+ "post": {
+ "summary": "Create configuration for a just-in-time runner for a repository",
+ "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/generate-runner-jitconfig-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "name",
+ "runner_group_id",
+ "labels"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the new runner."
+ },
+ "runner_group_id": {
+ "type": "integer",
+ "description": "The ID of the runner group to register the runner to."
+ },
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 100,
+ "items": {
+ "type": "string"
+ },
+ "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100."
+ },
+ "work_folder": {
+ "type": "string",
+ "description": "The working directory to be used for job execution, relative to the runner install directory.",
+ "default": "_work"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "New runner",
+ "runner_group_id": 1,
+ "labels": [
+ "self-hosted",
+ "X64",
+ "macOS",
+ "no-gpu"
+ ],
+ "work_folder": "_work"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "$ref": "#/components/responses/actions_runner_jitconfig"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/registration-token": {
+ "post": {
+ "summary": "Create a registration token for a repository",
+ "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-registration-token-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authentication-token"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authentication-token"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/remove-token": {
+ "post": {
+ "summary": "Create a remove token for a repository",
+ "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-remove-token-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/authentication-token"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/authentication-token-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/{runner_id}": {
+ "get": {
+ "summary": "Get a self-hosted runner for a repository",
+ "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/runner"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "delete": {
+ "summary": "Delete a self-hosted runner from a repository",
+ "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-self-hosted-runner-from-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
+ "get": {
+ "summary": "List labels for a self-hosted runner for a repository",
+ "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "post": {
+ "summary": "Add custom labels to a self-hosted runner for a repository",
+ "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "labels"
+ ],
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 100,
+ "description": "The names of the custom labels to add to the runner.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "gpu",
+ "accelerated"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "put": {
+ "summary": "Set custom labels for a self-hosted runner for a repository",
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "labels"
+ ],
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 0,
+ "maxItems": 100,
+ "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "gpu",
+ "accelerated"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ },
+ "delete": {
+ "summary": "Remove all custom labels from a self-hosted runner for a repository",
+ "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels_readonly"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
+ "delete": {
+ "summary": "Remove a custom label from a self-hosted runner for a repository",
+ "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/runner-id"
+ },
+ {
+ "$ref": "#/components/parameters/runner-label-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/components/responses/actions_runner_labels"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "self-hosted-runners"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs": {
+ "get": {
+ "summary": "List workflow runs for a repository",
+ "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-workflow-runs-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/actor"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-branch"
+ },
+ {
+ "$ref": "#/components/parameters/event"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-status"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/created"
+ },
+ {
+ "$ref": "#/components/parameters/exclude-pull-requests"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-check-suite-id"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-head-sha"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "workflow_runs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "workflow_runs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-run"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-run-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}": {
+ "get": {
+ "summary": "Get a workflow run",
+ "description": "Gets a specific workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "$ref": "#/components/parameters/exclude-pull-requests"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflow-run"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-run"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ },
+ "delete": {
+ "summary": "Delete a workflow run",
+ "description": "Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/delete-workflow-run",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": {
+ "get": {
+ "summary": "Get the review history for a workflow run",
+ "description": "Anyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-reviews-for-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/environment-approvals"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/environment-approvals-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": {
+ "post": {
+ "summary": "Approve a workflow run for a fork pull request",
+ "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/approve-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": {
+ "get": {
+ "summary": "List workflow run artifacts",
+ "description": "Lists artifacts for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-workflow-run-artifacts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/artifact-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "artifacts"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "artifacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/artifact"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/artifact-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "artifacts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
+ "get": {
+ "summary": "Get a workflow run attempt",
+ "description": "Gets a specific workflow run attempt.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow-run-attempt",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "$ref": "#/components/parameters/attempt-number"
+ },
+ {
+ "$ref": "#/components/parameters/exclude-pull-requests"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflow-run"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-run"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
+ "get": {
+ "summary": "List jobs for a workflow run attempt",
+ "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-jobs-for-workflow-run-attempt",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "$ref": "#/components/parameters/attempt-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "jobs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/job"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/job-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-jobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
+ "get": {
+ "summary": "Download workflow run attempt logs",
+ "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/download-workflow-run-attempt-logs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "$ref": "#/components/parameters/attempt-number"
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
+ "post": {
+ "summary": "Cancel a workflow run",
+ "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/cancel-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
+ "post": {
+ "summary": "Review custom deployment protection rules for a workflow run",
+ "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/review-custom-gates-for-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/review-custom-gates-comment-required"
+ },
+ {
+ "$ref": "#/components/schemas/review-custom-gates-state-required"
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "environment_name": "prod-eus",
+ "state": "approved",
+ "comment": "All health checks passed."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
+ "post": {
+ "summary": "Force cancel a workflow run",
+ "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/force-cancel-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
+ "get": {
+ "summary": "List jobs for a workflow run",
+ "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-jobs-for-workflow-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ },
+ {
+ "name": "filter",
+ "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "latest",
+ "all"
+ ],
+ "default": "latest"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "jobs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "jobs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/job"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/job-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-jobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": {
+ "get": {
+ "summary": "Download workflow run logs",
+ "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/download-workflow-run-logs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ },
+ "delete": {
+ "summary": "Delete workflow run logs",
+ "description": "Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-workflow-run-logs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": {
+ "get": {
+ "summary": "Get pending deployments for a workflow run",
+ "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-pending-deployments-for-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pending-deployment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pending-deployment-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ },
+ "post": {
+ "summary": "Review pending deployments for a workflow run",
+ "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/review-pending-deployments-for-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "environment_ids": {
+ "type": "array",
+ "description": "The list of environment ids to approve or reject",
+ "example": [
+ 161171787,
+ 161171795
+ ],
+ "items": {
+ "type": "integer",
+ "example": 161171787
+ }
+ },
+ "state": {
+ "type": "string",
+ "description": "Whether to approve or reject deployment to the specified environments.",
+ "enum": [
+ "approved",
+ "rejected"
+ ],
+ "example": "approved"
+ },
+ "comment": {
+ "type": "string",
+ "description": "A comment to accompany the deployment review",
+ "example": "Ship it!"
+ }
+ },
+ "required": [
+ "environment_ids",
+ "state",
+ "comment"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "environment_ids": [
+ 161171787
+ ],
+ "state": "approved",
+ "comment": "Ship it!"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
+ "post": {
+ "summary": "Re-run a workflow",
+ "description": "Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/re-run-workflow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enable_debug_logging": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to enable debug logging for the re-run."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": {
+ "post": {
+ "summary": "Re-run failed jobs from a workflow run",
+ "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/re-run-workflow-failed-jobs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enable_debug_logging": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to enable debug logging for the re-run."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
+ "get": {
+ "summary": "Get workflow run usage",
+ "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow-run-usage",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/run-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflow-run-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-run-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/secrets": {
+ "get": {
+ "summary": "List repository secrets",
+ "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-repo-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#list-repository-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/secrets/public-key": {
+ "get": {
+ "summary": "Get a repository public key",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-repo-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-a-repository-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get a repository secret",
+ "description": "Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update a repository secret",
+ "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-or-update-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository secret",
+ "description": "Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#delete-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/variables": {
+ "get": {
+ "summary": "List repository variables",
+ "description": "Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-repo-variables",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#list-repository-variables"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/variables-per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "variables"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "variables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-variable"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-variables-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "post": {
+ "summary": "Create a repository variable",
+ "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-repo-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#create-a-repository-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/variables/{name}": {
+ "get": {
+ "summary": "Get a repository variable",
+ "description": "Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-repo-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#get-a-repository-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-variable"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-variable"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "patch": {
+ "summary": "Update a repository variable",
+ "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/update-repo-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#update-a-repository-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository variable",
+ "description": "Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-repo-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows": {
+ "get": {
+ "summary": "List repository workflows",
+ "description": "Lists the workflows in a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-repo-workflows",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#list-repository-workflows"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "workflows"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "workflows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": {
+ "get": {
+ "summary": "Get a workflow",
+ "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#get-a-workflow"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflow"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": {
+ "put": {
+ "summary": "Disable a workflow",
+ "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/disable-workflow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#disable-a-workflow"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": {
+ "post": {
+ "summary": "Create a workflow dispatch event",
+ "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "operationId": "actions/create-workflow-dispatch",
+ "tags": [
+ "actions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "The git reference for the workflow. The reference can be a branch or tag name."
+ },
+ "inputs": {
+ "type": "object",
+ "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.",
+ "additionalProperties": true,
+ "maxProperties": 10
+ }
+ },
+ "required": [
+ "ref"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "topic-branch",
+ "inputs": {
+ "name": "Mona the Octocat",
+ "home": "San Francisco, CA"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": {
+ "put": {
+ "summary": "Enable a workflow",
+ "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/enable-workflow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#enable-a-workflow"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
+ "get": {
+ "summary": "List workflow runs for a workflow",
+ "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-workflow-runs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ },
+ {
+ "$ref": "#/components/parameters/actor"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-branch"
+ },
+ {
+ "$ref": "#/components/parameters/event"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-status"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/created"
+ },
+ {
+ "$ref": "#/components/parameters/exclude-pull-requests"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-check-suite-id"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-run-head-sha"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "workflow_runs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "workflow_runs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-run"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-run-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "workflow-runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": {
+ "get": {
+ "summary": "Get workflow usage",
+ "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-workflow-usage",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/workflows#get-workflow-usage"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/workflow-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflow-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/workflow-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "actions",
+ "subcategory": "workflows"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/activity": {
+ "get": {
+ "summary": "List repository activities",
+ "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-activities",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repository-activities"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "name": "ref",
+ "description": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "actor",
+ "description": "The GitHub username to use to filter by the actor who performed the activity.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "time_period",
+ "description": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "quarter",
+ "year"
+ ]
+ }
+ },
+ {
+ "name": "activity_type",
+ "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "push",
+ "force_push",
+ "branch_creation",
+ "branch_deletion",
+ "pr_merge",
+ "merge_queue_merge"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/activity"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/activity-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/assignees": {
+ "get": {
+ "summary": "List assignees",
+ "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/assignees#list-assignees"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/assignees/{assignee}": {
+ "get": {
+ "summary": "Check if a user can be assigned",
+ "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/check-user-can-be-assigned",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "assignee",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned."
+ },
+ "404": {
+ "description": "Otherwise a `404` status code is returned.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/autolinks": {
+ "get": {
+ "summary": "Get all autolinks of a repository",
+ "description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-autolinks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/autolink"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/autolink-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "autolinks"
+ }
+ },
+ "post": {
+ "summary": "Create an autolink reference for a repository",
+ "description": "Users with admin access to the repository can create an autolink.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-autolink",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key_prefix": {
+ "type": "string",
+ "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit."
+ },
+ "url_template": {
+ "type": "string",
+ "description": "The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`."
+ },
+ "is_alphanumeric": {
+ "type": "boolean",
+ "default": true,
+ "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters."
+ }
+ },
+ "required": [
+ "key_prefix",
+ "url_template"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query=",
+ "is_alphanumeric": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/autolink"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/autolink"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "autolinks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
+ "get": {
+ "summary": "Get an autolink reference of a repository",
+ "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-autolink",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/autolink-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/autolink"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/autolink"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "autolinks"
+ }
+ },
+ "delete": {
+ "summary": "Delete an autolink reference from a repository",
+ "description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-autolink",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/autolink-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "autolinks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/automated-security-fixes": {
+ "get": {
+ "summary": "Check if automated security fixes are enabled for a repository",
+ "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/check-automated-security-fixes",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response if dependabot is enabled",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-automated-security-fixes"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "enabled": true,
+ "paused": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if dependabot is not enabled for the repository"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "put": {
+ "summary": "Enable automated security fixes",
+ "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-automated-security-fixes",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#enable-automated-security-fixes"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "delete": {
+ "summary": "Disable automated security fixes",
+ "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-automated-security-fixes",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#disable-automated-security-fixes"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches": {
+ "get": {
+ "summary": "List branches",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branches#list-branches"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "protected",
+ "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/short-branch"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/short-branch-with-protection-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branches"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}": {
+ "get": {
+ "summary": "Get a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branches#get-a-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch-with-protection"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-get"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branches"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection": {
+ "get": {
+ "summary": "Get branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch-protection"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-protection"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "put": {
+ "summary": "Update branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#update-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required_status_checks": {
+ "type": "object",
+ "description": "Require status checks to pass before merging. Set to `null` to disable.",
+ "nullable": true,
+ "properties": {
+ "strict": {
+ "type": "boolean",
+ "description": "Require branches to be up to date before merging."
+ },
+ "contexts": {
+ "type": "array",
+ "deprecated": true,
+ "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n",
+ "items": {
+ "type": "string"
+ }
+ },
+ "checks": {
+ "type": "array",
+ "description": "The list of status checks to require in order to merge into this branch.",
+ "items": {
+ "type": "object",
+ "required": [
+ "context"
+ ],
+ "properties": {
+ "context": {
+ "type": "string",
+ "description": "The name of the required check"
+ },
+ "app_id": {
+ "type": "integer",
+ "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status."
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "strict",
+ "contexts"
+ ]
+ },
+ "enforce_admins": {
+ "type": "boolean",
+ "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.",
+ "nullable": true
+ },
+ "required_pull_request_reviews": {
+ "type": "object",
+ "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
+ "nullable": true,
+ "properties": {
+ "dismissal_restrictions": {
+ "type": "object",
+ "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The list of user `login`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "description": "The list of team `slug`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "description": "The list of app `slug`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit."
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them."
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers."
+ },
+ "require_last_push_approval": {
+ "type": "boolean",
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.",
+ "default": false
+ },
+ "bypass_pull_request_allowances": {
+ "type": "object",
+ "description": "Allow specific users, teams, or apps to bypass pull request requirements.",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The list of user `login`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "description": "The list of team `slug`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "description": "The list of app `slug`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "type": "object",
+ "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.",
+ "nullable": true,
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The list of user `login`s with push access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "description": "The list of team `slug`s with push access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "description": "The list of app `slug`s with push access",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users",
+ "teams"
+ ]
+ },
+ "required_linear_history": {
+ "type": "boolean",
+ "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation."
+ },
+ "allow_force_pushes": {
+ "type": "boolean",
+ "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"",
+ "nullable": true
+ },
+ "allow_deletions": {
+ "type": "boolean",
+ "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation."
+ },
+ "block_creations": {
+ "type": "boolean",
+ "description": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`."
+ },
+ "required_conversation_resolution": {
+ "type": "boolean",
+ "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`."
+ },
+ "lock_branch": {
+ "type": "boolean",
+ "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.",
+ "default": false
+ },
+ "allow_fork_syncing": {
+ "type": "boolean",
+ "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.",
+ "default": false
+ }
+ },
+ "required": [
+ "required_status_checks",
+ "enforce_admins",
+ "required_pull_request_reviews",
+ "restrictions"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "required_status_checks": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ },
+ "enforce_admins": true,
+ "required_pull_request_reviews": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2,
+ "require_last_push_approval": true,
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ }
+ },
+ "restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ],
+ "apps": [
+ "super-ci"
+ ]
+ },
+ "required_linear_history": true,
+ "allow_force_pushes": true,
+ "allow_deletions": true,
+ "block_creations": true,
+ "required_conversation_resolution": true,
+ "lock_branch": true,
+ "allow_fork_syncing": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-protection-update"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Delete branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#delete-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": {
+ "get": {
+ "summary": "Get admin branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-admin-enforced"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-admin-enforced-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Set admin branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-admin-enforced"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-admin-enforced-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Delete admin branch protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": {
+ "get": {
+ "summary": "Get pull request review protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-pull-request-review"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "patch": {
+ "summary": "Update pull request review protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "dismissal_restrictions": {
+ "type": "object",
+ "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The list of user `login`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "description": "The list of team `slug`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "description": "The list of app `slug`s with dismissal access",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit."
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed."
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers."
+ },
+ "require_last_push_approval": {
+ "type": "boolean",
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`",
+ "default": false
+ },
+ "bypass_pull_request_allowances": {
+ "type": "object",
+ "description": "Allow specific users, teams, or apps to bypass pull request requirements.",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The list of user `login`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "description": "The list of team `slug`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "description": "The list of app `slug`s allowed to bypass pull request requirements.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ],
+ "apps": [
+ "octoapp"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ],
+ "apps": [
+ "octoapp"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2,
+ "require_last_push_approval": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-pull-request-review"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Delete pull request review protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": {
+ "get": {
+ "summary": "Get commit signature protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-admin-enforced"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-admin-enforced"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Create commit signature protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/protected-branch-admin-enforced"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/protected-branch-admin-enforced"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Delete commit signature protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": {
+ "get": {
+ "summary": "Get status checks protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-status-checks-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/status-check-policy"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/status-check-policy"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "patch": {
+ "summary": "Update status check protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-status-check-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#update-status-check-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "strict": {
+ "type": "boolean",
+ "description": "Require branches to be up to date before merging."
+ },
+ "contexts": {
+ "type": "array",
+ "deprecated": true,
+ "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n",
+ "items": {
+ "type": "string"
+ }
+ },
+ "checks": {
+ "type": "array",
+ "description": "The list of status checks to require in order to merge into this branch.",
+ "items": {
+ "type": "object",
+ "required": [
+ "context"
+ ],
+ "properties": {
+ "context": {
+ "type": "string",
+ "description": "The name of the required check"
+ },
+ "app_id": {
+ "type": "integer",
+ "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status."
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/status-check-policy"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/status-check-policy"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Remove status check protection",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-status-check-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": {
+ "get": {
+ "summary": "Get all status check contexts",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Add status check contexts",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example adding status checks to a branch protection rule",
+ "value": {
+ "contexts": [
+ "continuous-integration/travis-ci",
+ "continuous-integration/jenkins"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "continuous-integration/travis-ci",
+ "continuous-integration/jenkins"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "contexts",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "put": {
+ "summary": "Set status check contexts",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example updating status checks for a branch protection rule",
+ "value": {
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "contexts",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Remove status check contexts",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The name of the status checks",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example removing status checks from a branch protection rule",
+ "value": {
+ "contexts": [
+ "continuous-integration/jenkins"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "contexts",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": {
+ "get": {
+ "summary": "Get access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch-restriction-policy"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-restriction-policy"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Delete access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": {
+ "get": {
+ "summary": "Get apps with access to the protected branch",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-apps-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Add app access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array",
+ "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "apps": [
+ "octoapp"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "apps",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "put": {
+ "summary": "Set app access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array",
+ "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "apps": [
+ "octoapp"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "apps",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Remove app access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array",
+ "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/integration-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "apps",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": {
+ "get": {
+ "summary": "Get teams with access to the protected branch",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-teams-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Add team access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example adding a team in a branch protection rule",
+ "value": {
+ "teams": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "teams",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "put": {
+ "summary": "Set team access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "justice-league"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example replacing a team in a branch protection rule",
+ "value": {
+ "teams": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "teams",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Remove team access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "description": "The slug values for teams",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example removing a team in a branch protection rule",
+ "value": {
+ "teams": [
+ "octocats"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "teams",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": {
+ "get": {
+ "summary": "Get users with access to the protected branch",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-users-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "post": {
+ "summary": "Add user access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The username for users",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example adding a user in a branch protection rule",
+ "value": {
+ "users": [
+ "octocat"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "users",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "put": {
+ "summary": "Set user access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The username for users",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example replacing a user in a branch protection rule",
+ "value": {
+ "users": [
+ "octocat"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "users",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ },
+ "delete": {
+ "summary": "Remove user access restrictions",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "The username for users",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example removing a user in a branch protection rule",
+ "value": {
+ "users": [
+ "octocat"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "requestBodyParameterName": "users",
+ "category": "branches",
+ "subcategory": "branch-protection"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches/{branch}/rename": {
+ "post": {
+ "summary": "Rename a branch",
+ "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/rename-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branches#rename-a-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "new_name": {
+ "type": "string",
+ "description": "The new name of the branch."
+ }
+ },
+ "required": [
+ "new_name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch-with-protection"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-with-protection"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branches"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-runs": {
+ "post": {
+ "summary": "Create a check run",
+ "description": "Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.\n\n**Note:** The 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 `pull_requests` array.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#create-a-check-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\"."
+ },
+ "head_sha": {
+ "type": "string",
+ "description": "The SHA of the commit."
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used."
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system."
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status.",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued"
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "conclusion": {
+ "type": "string",
+ "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
+ "enum": [
+ "action_required",
+ "cancelled",
+ "failure",
+ "neutral",
+ "success",
+ "skipped",
+ "stale",
+ "timed_out"
+ ]
+ },
+ "completed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "output": {
+ "type": "object",
+ "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the check run."
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 65535,
+ "description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
+ },
+ "text": {
+ "type": "string",
+ "maxLength": 65535,
+ "description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
+ },
+ "annotations": {
+ "type": "array",
+ "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".",
+ "maxItems": 50,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`."
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "The start line of the annotation. Line numbers start at 1."
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "The end line of the annotation."
+ },
+ "start_column": {
+ "type": "integer",
+ "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1."
+ },
+ "end_column": {
+ "type": "integer",
+ "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The level of the annotation.",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters."
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB."
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ }
+ },
+ "images": {
+ "type": "array",
+ "description": "Adds images to the output displayed in the GitHub pull request UI.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "The alternative text for the image."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "The full URL of the image."
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description."
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ }
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ]
+ },
+ "actions": {
+ "type": "array",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"",
+ "maxItems": 3,
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
+ },
+ "description": {
+ "type": "string",
+ "maxLength": 40,
+ "description": "A short explanation of what this action would do. The maximum size is 40 characters."
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ }
+ }
+ },
+ "required": [
+ "name",
+ "head_sha"
+ ],
+ "oneOf": [
+ {
+ "properties": {
+ "status": {
+ "enum": [
+ "completed"
+ ]
+ }
+ },
+ "required": [
+ "status",
+ "conclusion"
+ ],
+ "additionalProperties": true
+ },
+ {
+ "properties": {
+ "status": {
+ "enum": [
+ "queued",
+ "in_progress"
+ ]
+ }
+ },
+ "additionalProperties": true
+ }
+ ]
+ },
+ "examples": {
+ "example-of-in-progress-conclusion": {
+ "summary": "Example of an in_progress conclusion",
+ "value": {
+ "name": "mighty_readme",
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "status": "in_progress",
+ "external_id": "42",
+ "started_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "",
+ "text": ""
+ }
+ }
+ },
+ "example-of-completed-conclusion": {
+ "summary": "Example of a completed conclusion",
+ "value": {
+ "name": "mighty_readme",
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "status": "completed",
+ "started_at": "2017-11-30T19:39:10Z",
+ "conclusion": "success",
+ "completed_at": "2017-11-30T19:49:10Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notices.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations": [
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'banaas'.",
+ "raw_details": "Do you mean 'bananas' or 'banana'?",
+ "start_line": 2,
+ "end_line": 2
+ },
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'aples'",
+ "raw_details": "Do you mean 'apples' or 'Naples'",
+ "start_line": 4,
+ "end_line": 4
+ }
+ ],
+ "images": [
+ {
+ "alt": "Super bananas",
+ "image_url": "http://example.com/images/42"
+ }
+ ]
+ },
+ "actions": [
+ {
+ "label": "Fix",
+ "identifier": "fix_errors",
+ "description": "Allow us to fix these errors for you"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-run"
+ },
+ "examples": {
+ "example-of-completed-conclusion": {
+ "$ref": "#/components/examples/check-run-example-of-completed-conclusion"
+ },
+ "example-of-in-progress-conclusion": {
+ "$ref": "#/components/examples/check-run-example-of-in-progress-conclusion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-runs/{check_run_id}": {
+ "get": {
+ "summary": "Get a check run",
+ "description": "Gets a single check run using its `id`.\n\n**Note:** The 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 `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#get-a-check-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-run-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-run"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ },
+ "patch": {
+ "summary": "Update a check run",
+ "description": "Updates a check run for a specific commit in a repository.\n\n**Note:** The endpoints to manage checks only look 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 `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#update-a-check-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-run-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\"."
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check."
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system."
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status.",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "conclusion": {
+ "type": "string",
+ "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.",
+ "enum": [
+ "action_required",
+ "cancelled",
+ "failure",
+ "neutral",
+ "success",
+ "skipped",
+ "stale",
+ "timed_out"
+ ]
+ },
+ "completed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "output": {
+ "type": "object",
+ "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "**Required**."
+ },
+ "summary": {
+ "type": "string",
+ "description": "Can contain Markdown.",
+ "maxLength": 65535
+ },
+ "text": {
+ "type": "string",
+ "description": "Can contain Markdown.",
+ "maxLength": 65535
+ },
+ "annotations": {
+ "type": "array",
+ "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".",
+ "maxItems": 50,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`."
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "The start line of the annotation. Line numbers start at 1."
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "The end line of the annotation."
+ },
+ "start_column": {
+ "type": "integer",
+ "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1."
+ },
+ "end_column": {
+ "type": "integer",
+ "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The level of the annotation.",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters."
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB."
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ }
+ },
+ "images": {
+ "type": "array",
+ "description": "Adds images to the output displayed in the GitHub pull request UI.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "The alternative text for the image."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "The full URL of the image."
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description."
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ }
+ }
+ },
+ "required": [
+ "summary"
+ ]
+ },
+ "actions": {
+ "type": "array",
+ "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"",
+ "maxItems": 3,
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
+ },
+ "description": {
+ "type": "string",
+ "maxLength": 40,
+ "description": "A short explanation of what this action would do. The maximum size is 40 characters."
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ }
+ }
+ },
+ "anyOf": [
+ {
+ "properties": {
+ "status": {
+ "enum": [
+ "completed"
+ ]
+ }
+ },
+ "required": [
+ "conclusion"
+ ],
+ "additionalProperties": true
+ },
+ {
+ "properties": {
+ "status": {
+ "enum": [
+ "queued",
+ "in_progress"
+ ]
+ }
+ },
+ "additionalProperties": true
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "mighty_readme",
+ "started_at": "2018-05-04T01:14:52Z",
+ "status": "completed",
+ "conclusion": "success",
+ "completed_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notices.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations": [
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'banaas'.",
+ "raw_details": "Do you mean 'bananas' or 'banana'?",
+ "start_line": 2,
+ "end_line": 2
+ },
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'aples'",
+ "raw_details": "Do you mean 'apples' or 'Naples'",
+ "start_line": 4,
+ "end_line": 4
+ }
+ ],
+ "images": [
+ {
+ "alt": "Super bananas",
+ "image_url": "http://example.com/images/42"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-run"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": {
+ "get": {
+ "summary": "List check run annotations",
+ "description": "Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-annotations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#list-check-run-annotations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-run-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/check-annotation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-annotation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
+ "post": {
+ "summary": "Rerequest a check run",
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#rerequest-a-check-run"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-run-id"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation error if the check run is not rerequestable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-suites": {
+ "post": {
+ "summary": "Create a check suite",
+ "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**Note:** The 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 `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/suites#create-a-check-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "head_sha": {
+ "type": "string",
+ "description": "The sha of the head commit."
+ }
+ },
+ "required": [
+ "head_sha"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response when the suite already exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-suite"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-suite"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response when the suite was created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-suite"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-suite"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-suites/preferences": {
+ "patch": {
+ "summary": "Update repository preferences for check suites",
+ "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/set-suites-preferences",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "auto_trigger_checks": {
+ "type": "array",
+ "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "The `id` of the GitHub App."
+ },
+ "setting": {
+ "type": "boolean",
+ "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "default": true
+ }
+ },
+ "required": [
+ "app_id",
+ "setting"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-suite-preference"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-suite-preference"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": {
+ "get": {
+ "summary": "Get a check suite",
+ "description": "Gets a single check suite using its `id`.\n\n**Note:** The 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 `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/suites#get-a-check-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-suite-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/check-suite"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-suite"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
+ "get": {
+ "summary": "List check runs in a check suite",
+ "description": "Lists check runs for a check suite using its `id`.\n\n**Note:** The endpoints to manage checks only look 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 `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-suite-id"
+ },
+ {
+ "$ref": "#/components/parameters/check-name"
+ },
+ {
+ "$ref": "#/components/parameters/status"
+ },
+ {
+ "name": "filter",
+ "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "latest",
+ "all"
+ ],
+ "default": "latest"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "check_runs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_runs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/check-run"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": {
+ "post": {
+ "summary": "Rerequest a check suite",
+ "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/suites#rerequest-a-check-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/check-suite-id"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/alerts": {
+ "get": {
+ "summary": "List code scanning alerts for a repository",
+ "description": "Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/list-alerts-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/tool-name"
+ },
+ {
+ "$ref": "#/components/parameters/tool-guid"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/git-ref"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "state",
+ "description": "If specified, only code scanning alerts with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert-state-query"
+ }
+ },
+ {
+ "name": "severity",
+ "description": "If specified, only code scanning alerts with this severity will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert-severity"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-alert-items"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-alert-items"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
+ "get": {
+ "summary": "Get a code scanning alert",
+ "description": "Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/get-alert",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-alert"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ },
+ "patch": {
+ "summary": "Update a code scanning alert",
+ "description": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/update-alert",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "$ref": "#/components/schemas/code-scanning-alert-set-state"
+ },
+ "dismissed_reason": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
+ },
+ "dismissed_comment": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive",
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-alert-dismissed"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": {
+ "get": {
+ "summary": "List instances of a code scanning alert",
+ "description": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/list-alert-instances",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/git-ref"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-alert-instance"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-alert-instances"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/analyses": {
+ "get": {
+ "summary": "List code scanning analyses for a repository",
+ "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/list-recent-analyses",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/tool-name"
+ },
+ {
+ "$ref": "#/components/parameters/tool-guid"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "name": "ref",
+ "in": "query",
+ "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-ref"
+ }
+ },
+ {
+ "name": "sarif_id",
+ "in": "query",
+ "description": "Filter analyses belonging to the same SARIF upload.",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created"
+ ],
+ "default": "created"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-analysis"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-analysis-items"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
+ "get": {
+ "summary": "Get a code scanning analysis for a repository",
+ "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/get-analysis",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "analysis_id",
+ "in": "path",
+ "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-analysis"
+ },
+ "examples": {
+ "response": {
+ "$ref": "#/components/examples/code-scanning-analysis-default"
+ }
+ }
+ },
+ "application/json+sarif": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "examples": {
+ "response": {
+ "$ref": "#/components/examples/code-scanning-analysis-sarif"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ },
+ "delete": {
+ "summary": "Delete a code scanning analysis from a repository",
+ "description": "Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/delete-analysis",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "analysis_id",
+ "in": "path",
+ "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "confirm_delete",
+ "in": "query",
+ "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-analysis-deletion"
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/code-scanning-analysis-deletion"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/codeql/databases": {
+ "get": {
+ "summary": "List CodeQL databases for a repository",
+ "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/list-codeql-databases",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-codeql-database"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-codeql-databases"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
+ "get": {
+ "summary": "Get a CodeQL database for a repository",
+ "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/get-codeql-database",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "language",
+ "in": "path",
+ "description": "The language of the CodeQL database.",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-codeql-database"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-codeql-database"
+ }
+ }
+ }
+ }
+ },
+ "302": {
+ "$ref": "#/components/responses/found"
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/default-setup": {
+ "get": {
+ "summary": "Get a code scanning default setup configuration",
+ "description": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/get-default-setup",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-default-setup"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-default-setup"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ },
+ "patch": {
+ "summary": "Update a code scanning default setup configuration",
+ "description": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "tags": [
+ "code-scanning"
+ ],
+ "operationId": "code-scanning/update-default-setup",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-default-setup-update"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-default-setup-update"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-default-setup-update-response"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-default-setup-update-response"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/code_scanning_conflict"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/sarifs": {
+ "post": {
+ "summary": "Upload an analysis as SARIF data",
+ "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/upload-sarif",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "commit_sha": {
+ "$ref": "#/components/schemas/code-scanning-analysis-commit-sha"
+ },
+ "ref": {
+ "$ref": "#/components/schemas/code-scanning-ref-full"
+ },
+ "sarif": {
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-file"
+ },
+ "checkout_uri": {
+ "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.",
+ "example": "file:///github/workspace/",
+ "type": "string",
+ "format": "uri"
+ },
+ "started_at": {
+ "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "tool_name": {
+ "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.",
+ "type": "string"
+ },
+ "validate": {
+ "description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "commit_sha",
+ "ref",
+ "sarif"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
+ "ref": "refs/heads/master",
+ "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-sarifs-receipt"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-sarif-upload"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request if the sarif field is invalid"
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "413": {
+ "description": "Payload Too Large if the sarif field is too large"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": {
+ "get": {
+ "summary": "Get information about a SARIF upload",
+ "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\"\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
+ "operationId": "code-scanning/get-sarif",
+ "tags": [
+ "code-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sarif_id",
+ "description": "The SARIF ID obtained after uploading.",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-sarifs-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-scanning-sarif-upload-status"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
+ },
+ "404": {
+ "description": "Not Found if the sarif id does not match any upload"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "code-scanning",
+ "subcategory": "code-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codeowners/errors": {
+ "get": {
+ "summary": "List CODEOWNERS errors",
+ "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/codeowners-errors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-codeowners-errors"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codeowners-errors"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codeowners-errors"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces": {
+ "get": {
+ "summary": "List codespaces in a repository for the authenticated user",
+ "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-in-repository-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "codespaces"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "codespaces": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-list-for-repository"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ },
+ "post": {
+ "summary": "Create a codespace in a repository",
+ "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-with-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "ref": {
+ "description": "Git ref (typically a branch name) for this codespace",
+ "type": "string"
+ },
+ "location": {
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
+ "type": "string"
+ },
+ "geo": {
+ "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.",
+ "type": "string",
+ "enum": [
+ "EuropeWest",
+ "SoutheastAsia",
+ "UsEast",
+ "UsWest"
+ ]
+ },
+ "client_ip": {
+ "description": "IP for location auto-detection when proxying a request",
+ "type": "string"
+ },
+ "machine": {
+ "description": "Machine type to use for this codespace",
+ "type": "string"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json config to use for this codespace",
+ "type": "string"
+ },
+ "multi_repo_permissions_opt_out": {
+ "description": "Whether to authorize requested permissions from devcontainer.json",
+ "type": "boolean"
+ },
+ "working_directory": {
+ "description": "Working directory for this codespace",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "Time in minutes before codespace stops from inactivity",
+ "type": "integer"
+ },
+ "display_name": {
+ "description": "Display name for this codespace",
+ "type": "string"
+ },
+ "retention_period_minutes": {
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
+ "type": "integer"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "main",
+ "machine": "standardLinux32gb"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when the codespace was successfully created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Response when the codespace creation partially failed but is being retried in the background",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/devcontainers": {
+ "get": {
+ "summary": "List devcontainer configurations in a repository for the authenticated user",
+ "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "devcontainers"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "devcontainers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "path"
+ ],
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "display_name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/machines": {
+ "get": {
+ "summary": "List available machine types for a repository",
+ "description": "List the machine types available for a given repository based on its configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/repo-machines-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "location",
+ "description": "The location to check for available machines. Assigned by IP if not provided.",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "WestUs2"
+ }
+ },
+ {
+ "name": "client_ip",
+ "description": "IP for location auto-detection when proxying a request",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "The branch or commit to check for prebuild availability and devcontainer restrictions.",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "main"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "machines"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "machines": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace-machine"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace-machines-list"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "machines"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/new": {
+ "get": {
+ "summary": "Get default attributes for a codespace",
+ "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "description": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "main"
+ }
+ },
+ {
+ "name": "client_ip",
+ "description": "An alternative IP for default location auto-detection, such as when proxying a request.",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "1.2.3.4"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response when a user is able to create codespaces from the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "billable_owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "defaults": {
+ "type": "object",
+ "required": [
+ "location",
+ "devcontainer_path"
+ ],
+ "properties": {
+ "location": {
+ "type": "string"
+ },
+ "devcontainer_path": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-default-attributes-for-a-codespace"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/permissions_check": {
+ "get": {
+ "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user",
+ "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/check-permissions-for-devcontainer",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "master"
+ }
+ },
+ {
+ "name": "devcontainer_path",
+ "description": "Path to the devcontainer.json configuration to use for the permission check.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": ".devcontainer/example/devcontainer.json"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response when the permission check is successful",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/secrets": {
+ "get": {
+ "summary": "List repository secrets",
+ "description": "Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-repo-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repo-codespaces-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-codespaces-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "repository-secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/secrets/public-key": {
+ "get": {
+ "summary": "Get a repository public key",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-repo-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "repository-secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get a repository secret",
+ "description": "Gets a single repository development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repo-codespaces-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-codespaces-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "repository-secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update a repository secret",
+ "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-or-update-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "repository-secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository secret",
+ "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "codespaces",
+ "subcategory": "repository-secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/collaborators": {
+ "get": {
+ "summary": "List repository collaborators",
+ "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "affiliation",
+ "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "outside",
+ "direct",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "permission",
+ "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/collaborator"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/collaborator-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/collaborators/{username}": {
+ "get": {
+ "summary": "Check if a user is a repository collaborator",
+ "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/check-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if user is a collaborator"
+ },
+ "404": {
+ "description": "Not Found if user is not a collaborator"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "collaborators"
+ }
+ },
+ "put": {
+ "summary": "Add a repository collaborator",
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.",
+ "default": "push"
+ }
+ }
+ },
+ "examples": {
+ "new-invitation-is-created": {
+ "summary": "Add a collaborator with triage permissions",
+ "value": {
+ "permission": "triage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when a new invitation is created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-invitation"
+ },
+ "examples": {
+ "new-invitation-is-created": {
+ "$ref": "#/components/examples/repository-invitation-response-when-a-new-invitation-is-created"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "collaborators"
+ }
+ },
+ "delete": {
+ "summary": "Remove a repository collaborator",
+ "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when collaborator was removed from the repository."
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/collaborators/{username}/permission": {
+ "get": {
+ "summary": "Get repository permissions for a user",
+ "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-collaborator-permission-level",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "if user has admin permissions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-collaborator-permission"
+ },
+ "examples": {
+ "response-if-user-has-admin-permissions": {
+ "$ref": "#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "collaborators"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/comments": {
+ "get": {
+ "summary": "List commit comments for a repository",
+ "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/comments/{comment_id}": {
+ "get": {
+ "summary": "Get a commit comment",
+ "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#get-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comment"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ },
+ "patch": {
+ "summary": "Update a commit comment",
+ "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#update-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The contents of the comment"
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comment-2"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a commit comment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#delete-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": {
+ "get": {
+ "summary": "List reactions for a commit comment",
+ "description": "List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a commit comment",
+ "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete a commit comment reaction",
+ "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits": {
+ "get": {
+ "summary": "List commits",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/commits#list-commits"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sha",
+ "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "path",
+ "description": "Only commits containing this file path will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "author",
+ "description": "GitHub username or email address to use to filter by commit author.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "committer",
+ "description": "GitHub username or email address to use to filter by commit committer.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "name": "until",
+ "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": {
+ "get": {
+ "summary": "List branches for HEAD commit",
+ "description": "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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches-for-head-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/commits#list-branches-for-head-commit"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-sha"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/branch-short"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/branch-short-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": {
+ "get": {
+ "summary": "List commit comments",
+ "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-comments-for-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#list-commit-comments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-sha"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create a commit comment",
+ "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/comments#create-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-sha"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The contents of the comment."
+ },
+ "path": {
+ "type": "string",
+ "description": "Relative path of the file to comment on."
+ },
+ "position": {
+ "type": "integer",
+ "description": "Line index in the diff to comment on."
+ },
+ "line": {
+ "type": "integer",
+ "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comment"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
+ "get": {
+ "summary": "List pull requests associated with a commit",
+ "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pull-requests-associated-with-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-sha"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{ref}": {
+ "get": {
+ "summary": "Get a commit",
+ "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/commits#get-a-commit"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{ref}/check-runs": {
+ "get": {
+ "summary": "List check runs for a Git reference",
+ "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look 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 `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ },
+ {
+ "$ref": "#/components/parameters/check-name"
+ },
+ {
+ "$ref": "#/components/parameters/status"
+ },
+ {
+ "name": "filter",
+ "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "latest",
+ "all"
+ ],
+ "default": "latest"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "app_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "check_runs"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_runs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/check-run"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{ref}/check-suites": {
+ "get": {
+ "summary": "List check suites for a Git reference",
+ "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look 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 `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-suites-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ },
+ {
+ "name": "app_id",
+ "description": "Filters check suites by GitHub App `id`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "example": 1
+ },
+ {
+ "$ref": "#/components/parameters/check-name"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "check_suites"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_suites": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/check-suite"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-suite-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{ref}/status": {
+ "get": {
+ "summary": "Get the combined status for a specific reference",
+ "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-combined-status-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/combined-commit-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/combined-commit-status"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "statuses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits/{ref}/statuses": {
+ "get": {
+ "summary": "List commit statuses for a reference",
+ "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-statuses-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/status"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/status-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "statuses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/community/profile": {
+ "get": {
+ "summary": "Get community profile metrics",
+ "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-community-profile-metrics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/community#get-community-profile-metrics"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/community-profile"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/community-profile"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "community"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/compare/{basehead}": {
+ "get": {
+ "summary": "Compare two commits",
+ "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/compare-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/commits#compare-two-commits"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "name": "basehead",
+ "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.",
+ "in": "path",
+ "required": true,
+ "x-multi-segment": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit-comparison"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-comparison"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/contents/{path}": {
+ "get": {
+ "summary": "Get repository content",
+ "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-content",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#get-repository-content"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "path",
+ "description": "path parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ {
+ "name": "ref",
+ "description": "The name of the commit/branch/tag. Default: the repository’s default branch.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/vnd.github.object": {
+ "schema": {
+ "$ref": "#/components/schemas/content-tree"
+ },
+ "examples": {
+ "response-if-content-is-a-file": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-file"
+ },
+ "response-if-content-is-a-directory": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-directory-object"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/content-directory"
+ },
+ {
+ "$ref": "#/components/schemas/content-file"
+ },
+ {
+ "$ref": "#/components/schemas/content-symlink"
+ },
+ {
+ "$ref": "#/components/schemas/content-submodule"
+ }
+ ]
+ },
+ "examples": {
+ "response-if-content-is-a-file": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-file"
+ },
+ "response-if-content-is-a-directory": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-directory"
+ },
+ "response-if-content-is-a-symlink": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-symlink"
+ },
+ "response-if-content-is-a-submodule": {
+ "$ref": "#/components/examples/content-file-response-if-content-is-a-submodule"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "302": {
+ "$ref": "#/components/responses/found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ },
+ "put": {
+ "summary": "Create or update file contents",
+ "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-or-update-file-contents",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#create-or-update-file-contents"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "path",
+ "description": "path parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The commit message."
+ },
+ "content": {
+ "type": "string",
+ "description": "The new file content, using Base64 encoding."
+ },
+ "sha": {
+ "type": "string",
+ "description": "**Required if you are updating a file**. The blob SHA of the file being replaced."
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch."
+ },
+ "committer": {
+ "type": "object",
+ "description": "The person that committed the file. Default: the authenticated user.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted."
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted."
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\""
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ]
+ },
+ "author": {
+ "type": "object",
+ "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted."
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted."
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\""
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ]
+ }
+ },
+ "required": [
+ "message",
+ "content"
+ ]
+ },
+ "examples": {
+ "example-for-creating-a-file": {
+ "summary": "Example for creating a file",
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "content": "bXkgbmV3IGZpbGUgY29udGVudHM="
+ }
+ },
+ "example-for-updating-a-file": {
+ "summary": "Example for updating a file",
+ "value": {
+ "message": "a new commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz",
+ "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/file-commit"
+ },
+ "examples": {
+ "example-for-updating-a-file": {
+ "$ref": "#/components/examples/file-commit-example-for-updating-a-file"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/file-commit"
+ },
+ "examples": {
+ "example-for-creating-a-file": {
+ "$ref": "#/components/examples/file-commit-example-for-creating-a-file"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ },
+ "delete": {
+ "summary": "Delete a file",
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-file",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#delete-a-file"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "path",
+ "description": "path parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The commit message."
+ },
+ "sha": {
+ "type": "string",
+ "description": "The blob SHA of the file being deleted."
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch"
+ },
+ "committer": {
+ "type": "object",
+ "description": "object containing information about the committer.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ }
+ }
+ },
+ "author": {
+ "type": "object",
+ "description": "object containing information about the author.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ }
+ }
+ }
+ },
+ "required": [
+ "message",
+ "sha"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/file-commit"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/file-commit"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/contributors": {
+ "get": {
+ "summary": "List repository contributors",
+ "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-contributors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repository-contributors"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "anon",
+ "description": "Set to `1` or `true` to include anonymous contributors in results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If repository contains content",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/contributor"
+ }
+ },
+ "examples": {
+ "response-if-repository-contains-content": {
+ "$ref": "#/components/examples/contributor-items-response-if-repository-contains-content"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "204": {
+ "description": "Response if repository is empty"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependabot/alerts": {
+ "get": {
+ "summary": "List Dependabot alerts for a repository",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-alerts-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-states"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-scope"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "page",
+ "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
+ "deprecated": true,
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "deprecated": true,
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-first"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-last"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-alerts-for-repository"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "dependabot",
+ "subcategory": "alerts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": {
+ "get": {
+ "summary": "Get a Dependabot alert",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/get-alert",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-alert-open"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "dependabot",
+ "subcategory": "alerts"
+ }
+ },
+ "patch": {
+ "summary": "Update a Dependabot alert",
+ "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/update-alert",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/dependabot-alert-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.",
+ "enum": [
+ "dismissed",
+ "open"
+ ]
+ },
+ "dismissed_reason": {
+ "type": "string",
+ "description": "**Required when `state` is `dismissed`.** A reason for dismissing the alert.",
+ "enum": [
+ "fix_started",
+ "inaccurate",
+ "no_bandwidth",
+ "not_used",
+ "tolerable_risk"
+ ]
+ },
+ "dismissed_comment": {
+ "type": "string",
+ "description": "An optional comment associated with dismissing the alert.",
+ "maxLength": 280
+ }
+ },
+ "required": [
+ "state"
+ ],
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "tolerable_risk",
+ "dismissed_comment": "This alert is accurate but we use a sanitizer."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-alert-dismissed"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "dependabot",
+ "subcategory": "alerts"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependabot/secrets": {
+ "get": {
+ "summary": "List repository secrets",
+ "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/list-repo-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#list-repository-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/dependabot-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependabot/secrets/public-key": {
+ "get": {
+ "summary": "Get a repository public key",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/get-repo-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependabot-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get a repository secret",
+ "description": "Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/get-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependabot-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependabot-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update a repository secret",
+ "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/create-or-update-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository secret",
+ "description": "Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "dependabot"
+ ],
+ "operationId": "dependabot/delete-repo-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependabot",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": {
+ "get": {
+ "summary": "Get a diff of the dependencies between commits",
+ "description": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.",
+ "tags": [
+ "dependency-graph"
+ ],
+ "operationId": "dependency-graph/diff-range",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "basehead",
+ "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/manifest-path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependency-graph-diff"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/diff-range-response"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/dependency_review_forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "dependency-graph",
+ "subcategory": "dependency-review"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependency-graph/sbom": {
+ "get": {
+ "summary": "Export a software bill of materials (SBOM) for a repository.",
+ "description": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.",
+ "tags": [
+ "dependency-graph"
+ ],
+ "operationId": "dependency-graph/export-sbom",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/dependency-graph-spdx-sbom"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/dependency-graph-export-sbom-response"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "dependency-graph",
+ "subcategory": "sboms"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dependency-graph/snapshots": {
+ "post": {
+ "summary": "Create a snapshot of dependencies for a repository",
+ "description": "Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "dependency-graph"
+ ],
+ "operationId": "dependency-graph/create-repository-snapshot",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/snapshot"
+ },
+ "examples": {
+ "example-of-a-dependency-submission": {
+ "$ref": "#/components/examples/dependency-graph-create-snapshot-request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "id",
+ "created_at",
+ "result",
+ "message"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "ID of the created snapshot."
+ },
+ "created_at": {
+ "type": "string",
+ "description": "The time at which the snapshot was created."
+ },
+ "result": {
+ "type": "string",
+ "description": "Either \"SUCCESS\", \"ACCEPTED\", or \"INVALID\". \"SUCCESS\" indicates that the snapshot was successfully created and the repository's dependencies were updated. \"ACCEPTED\" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. \"INVALID\" indicates that the snapshot was malformed."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message providing further details about the result, such as why the dependencies were not updated."
+ }
+ }
+ },
+ "examples": {
+ "example-of-a-dependency-submission": {
+ "$ref": "#/components/examples/dependency-graph-create-snapshot-success"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "dependency-graph",
+ "subcategory": "dependency-submission"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/deployments": {
+ "get": {
+ "summary": "List deployments",
+ "description": "Simple filtering of deployments is available via query parameters:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/deployments#list-deployments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sha",
+ "description": "The SHA recorded at creation time.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "The name of the ref. This can be a branch, tag, or SHA.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ }
+ },
+ {
+ "name": "task",
+ "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ }
+ },
+ {
+ "name": "environment",
+ "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none",
+ "nullable": true
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "deployments"
+ }
+ },
+ "post": {
+ "summary": "Create a deployment",
+ "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/deployments#create-a-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "The ref to deploy. This can be a branch, tag, or SHA."
+ },
+ "task": {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "default": "deploy"
+ },
+ "auto_merge": {
+ "type": "boolean",
+ "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "default": true
+ },
+ "required_contexts": {
+ "type": "array",
+ "description": "The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "payload": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": true
+ },
+ {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.",
+ "default": ""
+ }
+ ]
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "default": "production"
+ },
+ "description": {
+ "type": "string",
+ "description": "Short description of the deployment.",
+ "default": "",
+ "nullable": true
+ },
+ "transient_environment": {
+ "type": "boolean",
+ "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`",
+ "default": false
+ },
+ "production_environment": {
+ "type": "boolean",
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise."
+ }
+ },
+ "required": [
+ "ref"
+ ]
+ },
+ "examples": {
+ "simple-example": {
+ "summary": "Simple example",
+ "value": {
+ "ref": "topic-branch",
+ "payload": "{ \"deploy\": \"migrate\" }",
+ "description": "Deploy request from hubot"
+ }
+ },
+ "advanced-example": {
+ "summary": "Advanced example",
+ "value": {
+ "ref": "topic-branch",
+ "auto_merge": false,
+ "payload": "{ \"deploy\": \"migrate\" }",
+ "description": "Deploy request from hubot",
+ "required_contexts": [
+ "ci/janky",
+ "security/brakeman"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment"
+ },
+ "examples": {
+ "simple-example": {
+ "$ref": "#/components/examples/deployment-simple-example"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Merged branch response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "merged-branch-response": {
+ "value": {
+ "message": "Auto-merged master into topic-branch on deployment."
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict when there is a merge conflict or the commit's status checks failed"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "deployments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/deployments/{deployment_id}": {
+ "get": {
+ "summary": "Get a deployment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/deployments#get-a-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/deployment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "deployments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a deployment",
+ "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/deployments#delete-a-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/deployment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "deployments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": {
+ "get": {
+ "summary": "List deployment statuses",
+ "description": "Users with pull access can view deployment statuses for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployment-statuses",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/statuses#list-deployment-statuses"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/deployment-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deployment-status"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-status-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "statuses"
+ }
+ },
+ "post": {
+ "summary": "Create a deployment status",
+ "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/statuses#create-a-deployment-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/deployment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "enum": [
+ "error",
+ "failure",
+ "inactive",
+ "in_progress",
+ "queued",
+ "pending",
+ "success"
+ ]
+ },
+ "target_url": {
+ "type": "string",
+ "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.",
+ "default": ""
+ },
+ "log_url": {
+ "type": "string",
+ "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`",
+ "default": ""
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.",
+ "default": ""
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used."
+ },
+ "environment_url": {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: `\"\"`",
+ "default": ""
+ },
+ "auto_inactive": {
+ "type": "boolean",
+ "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`"
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-status"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "statuses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": {
+ "get": {
+ "summary": "Get a deployment status",
+ "description": "Users with pull access can view a deployment status for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/statuses#get-a-deployment-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/deployment-id"
+ },
+ {
+ "name": "status_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-status"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "statuses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/dispatches": {
+ "post": {
+ "summary": "Create a repository dispatch event",
+ "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-dispatch-event",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "event_type"
+ ],
+ "properties": {
+ "event_type": {
+ "type": "string",
+ "description": "A custom webhook event name. Must be 100 characters or fewer.",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "client_payload": {
+ "type": "object",
+ "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.",
+ "additionalProperties": true,
+ "maxProperties": 10
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "event_type": "on-demand-test",
+ "client_payload": {
+ "unit": false,
+ "integration": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments": {
+ "get": {
+ "summary": "List environments",
+ "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-environments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/environments#list-environments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "description": "The number of environments in this repository",
+ "example": 5,
+ "type": "integer"
+ },
+ "environments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/environment"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/environments"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "environments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}": {
+ "get": {
+ "summary": "Get an environment",
+ "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-environment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/environments#get-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/environment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/environment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "environments"
+ }
+ },
+ "put": {
+ "summary": "Create or update an environment",
+ "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-or-update-environment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/environments#create-or-update-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "wait_timer": {
+ "$ref": "#/components/schemas/wait-timer"
+ },
+ "prevent_self_review": {
+ "$ref": "#/components/schemas/prevent-self-review"
+ },
+ "reviewers": {
+ "type": "array",
+ "nullable": true,
+ "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/deployment-reviewer-type"
+ },
+ "id": {
+ "type": "integer",
+ "description": "The id of the user or team who can review the deployment",
+ "example": 4532992
+ }
+ }
+ }
+ },
+ "deployment_branch_policy": {
+ "$ref": "#/components/schemas/deployment-branch-policy-settings"
+ }
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "wait_timer": 30,
+ "prevent_self_review": false,
+ "reviewers": [
+ {
+ "type": "User",
+ "id": 1
+ },
+ {
+ "type": "Team",
+ "id": 1
+ }
+ ],
+ "deployment_branch_policy": {
+ "protected_branches": false,
+ "custom_branch_policies": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/environment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/environment"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "environments"
+ }
+ },
+ "delete": {
+ "summary": "Delete an environment",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-an-environment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/environments#delete-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Default response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "environments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
+ "get": {
+ "summary": "List deployment branch policies",
+ "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployment-branch-policies",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "description": "The number of deployment branch policies for the environment.",
+ "type": "integer",
+ "example": 2
+ },
+ "branch_policies": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deployment-branch-policy"
+ }
+ }
+ },
+ "required": [
+ "total_count",
+ "branch_policies"
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-branch-policies-list"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "branch-policies"
+ }
+ },
+ "post": {
+ "summary": "Create a deployment branch policy",
+ "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-branch-policy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
+ },
+ "examples": {
+ "example-wildcard": {
+ "summary": "Example of a wildcard name pattern",
+ "value": {
+ "name": "release/*"
+ }
+ },
+ "example-single-branch": {
+ "summary": "Example of a single branch name pattern",
+ "value": {
+ "name": "main",
+ "type": "branch"
+ }
+ },
+ "example-single-tag": {
+ "summary": "Example of a single tag name pattern",
+ "value": {
+ "name": "v1",
+ "type": "tag"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-branch-policy"
+ },
+ "examples": {
+ "example-wildcard": {
+ "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+ },
+ "example-single-branch": {
+ "$ref": "#/components/examples/deployment-branch-policy-single-branch"
+ },
+ "example-single-tag": {
+ "$ref": "#/components/examples/deployment-branch-policy-single-tag"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
+ },
+ "303": {
+ "description": "Response if the same branch name pattern already exists"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "branch-policies"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
+ "get": {
+ "summary": "Get a deployment branch policy",
+ "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment-branch-policy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/branch-policy-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-branch-policy"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "branch-policies"
+ }
+ },
+ "put": {
+ "summary": "Update a deployment branch policy",
+ "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-deployment-branch-policy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/branch-policy-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "release/*"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-branch-policy"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-branch-policy-wildcard"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "branch-policies"
+ }
+ },
+ "delete": {
+ "summary": "Delete a deployment branch policy",
+ "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-deployment-branch-policy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/branch-policy-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "branch-policies"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
+ "get": {
+ "summary": "Get all deployment protection rules for an environment",
+ "description": "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 \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-deployment-protection-rules",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of deployment protection rules",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "description": "The number of enabled custom deployment protection rules for this environment",
+ "type": "integer",
+ "example": 10
+ },
+ "custom_deployment_protection_rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deployment-protection-rule"
+ }
+ }
+ },
+ "example": {
+ "$ref": "#/components/examples/deployment-protection-rules"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 2,
+ "custom_deployment_protection_rules": [
+ {
+ "id": 3,
+ "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
+ "enabled": true,
+ "app": {
+ "id": 1,
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
+ "slug": "a-custom-app",
+ "integration_url": "https://api.github.com/apps/a-custom-app"
+ }
+ },
+ {
+ "id": 4,
+ "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128",
+ "enabled": true,
+ "app": {
+ "id": 1,
+ "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
+ "slug": "another-custom-app",
+ "integration_url": "https://api.github.com/apps/another-custom-app"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "protection-rules"
+ }
+ },
+ "post": {
+ "summary": "Create a custom deployment protection rule on an environment",
+ "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-protection-rule",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "integration_id": {
+ "type": "integer",
+ "description": "The ID of the custom app that will be enabled on the environment."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "integration_id": 5
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "The enabled custom deployment protection rule",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-protection-rule"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-protection-rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "protection-rules"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
+ "get": {
+ "summary": "List custom deployment rule integrations available for an environment",
+ "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-custom-deployment-rule-integrations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of custom deployment rule integrations available for this environment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "description": "The total number of custom deployment protection rule integrations available for this environment.",
+ "type": "integer",
+ "example": 35
+ },
+ "available_custom_deployment_protection_rule_integrations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/custom-deployment-protection-rule-apps"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "protection-rules"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
+ "get": {
+ "summary": "Get a custom deployment protection rule",
+ "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-custom-deployment-protection-rule",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/protection-rule-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment-protection-rule"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deployment-protection-rule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "protection-rules"
+ }
+ },
+ "delete": {
+ "summary": "Disable a custom protection rule for an environment",
+ "description": "Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-deployment-protection-rule",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/protection-rule-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deployments",
+ "subcategory": "protection-rules"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/events": {
+ "get": {
+ "summary": "List repository events",
+ "description": "**Note**: This 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.\n",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-repository-events"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "200-response": {
+ "$ref": "#/components/examples/repo-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/forks": {
+ "get": {
+ "summary": "List forks",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/forks#list-forks"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sort",
+ "description": "The sort order. `stargazers` will sort by star count.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "newest",
+ "oldest",
+ "stargazers",
+ "watchers"
+ ],
+ "default": "newest"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "forks"
+ }
+ },
+ "post": {
+ "summary": "Create a fork",
+ "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/forks#create-a-fork"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "organization": {
+ "type": "string",
+ "description": "Optional parameter to specify the organization name if forking into an organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "When forking from an existing repository, a new name for the fork."
+ },
+ "default_branch_only": {
+ "type": "boolean",
+ "description": "When forking from an existing repository, fork with only the default branch."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "organization": "octocat",
+ "name": "Hello-World",
+ "default_branch_only": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "forks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/blobs": {
+ "post": {
+ "summary": "Create a blob",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/blobs#create-a-blob"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The new blob's content."
+ },
+ "encoding": {
+ "type": "string",
+ "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
+ "default": "utf-8"
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/short-blob"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/short-blob"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "blobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/blobs/{file_sha}": {
+ "get": {
+ "summary": "Get a blob",
+ "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/blobs#get-a-blob"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "file_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/blob"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/blob"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "blobs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/commits": {
+ "post": {
+ "summary": "Create a commit",
+ "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/commits#create-a-commit"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The commit message"
+ },
+ "tree": {
+ "type": "string",
+ "description": "The SHA of the tree object this commit points to"
+ },
+ "parents": {
+ "type": "array",
+ "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "author": {
+ "type": "object",
+ "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ },
+ "date": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ]
+ },
+ "committer": {
+ "type": "object",
+ "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ },
+ "date": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ }
+ },
+ "signature": {
+ "type": "string",
+ "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits."
+ }
+ },
+ "required": [
+ "message",
+ "tree"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "author": {
+ "name": "Mona Octocat",
+ "email": "octocat@github.com",
+ "date": "2008-07-09T16:13:30+12:00"
+ },
+ "parents": [
+ "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+ ],
+ "tree": "827efc6d56897b048c772eb4087f854f46256132",
+ "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-commit"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-commit"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/commits/{commit_sha}": {
+ "get": {
+ "summary": "Get a commit object",
+ "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/commits#get-a-commit-object"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-sha"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-commit"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-commit-2"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/matching-refs/{ref}": {
+ "get": {
+ "summary": "List matching references",
+ "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/list-matching-refs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/refs#list-matching-references"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/git-ref"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-ref-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "refs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/ref/{ref}": {
+ "get": {
+ "summary": "Get a reference",
+ "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/refs#get-a-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-ref"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-ref"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "refs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/refs": {
+ "post": {
+ "summary": "Create a reference",
+ "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/refs#create-a-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected."
+ },
+ "sha": {
+ "type": "string",
+ "description": "The SHA1 value for this reference."
+ }
+ },
+ "required": [
+ "ref",
+ "sha"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-ref"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-ref"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "refs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/refs/{ref}": {
+ "patch": {
+ "summary": "Update a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/update-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/refs#update-a-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+ "in": "path",
+ "required": true,
+ "example": "heads/featureA",
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "description": "The SHA1 value to set this reference to"
+ },
+ "force": {
+ "type": "boolean",
+ "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.",
+ "default": false
+ }
+ },
+ "required": [
+ "sha"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-ref"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-ref"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "refs"
+ }
+ },
+ "delete": {
+ "summary": "Delete a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/delete-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/refs#delete-a-reference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/commit-ref"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "refs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/tags": {
+ "post": {
+ "summary": "Create a tag object",
+ "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/tags#create-a-tag-object"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag": {
+ "type": "string",
+ "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")."
+ },
+ "message": {
+ "type": "string",
+ "description": "The tag message."
+ },
+ "object": {
+ "type": "string",
+ "description": "The SHA of the git object this is tagging."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
+ "enum": [
+ "commit",
+ "tree",
+ "blob"
+ ]
+ },
+ "tagger": {
+ "type": "object",
+ "description": "An object with information about the individual creating the tag.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author of the tag"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author of the tag"
+ },
+ "date": {
+ "type": "string",
+ "format": "date-time",
+ "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ]
+ }
+ },
+ "required": [
+ "tag",
+ "message",
+ "object",
+ "type"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-tag"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-tag"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "tags"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/tags/{tag_sha}": {
+ "get": {
+ "summary": "Get a tag",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/tags#get-a-tag"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "tag_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-tag"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-tag"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "tags"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/trees": {
+ "post": {
+ "summary": "Create a tree",
+ "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/trees#create-a-tree"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tree": {
+ "type": "array",
+ "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The file referenced in the tree."
+ },
+ "mode": {
+ "type": "string",
+ "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.",
+ "enum": [
+ "100644",
+ "100755",
+ "040000",
+ "160000",
+ "120000"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "description": "Either `blob`, `tree`, or `commit`.",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ]
+ },
+ "sha": {
+ "type": "string",
+ "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.",
+ "nullable": true
+ },
+ "content": {
+ "type": "string",
+ "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error."
+ }
+ }
+ }
+ },
+ "base_tree": {
+ "type": "string",
+ "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n"
+ }
+ },
+ "required": [
+ "tree"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-tree"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/git-tree"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "trees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
+ "get": {
+ "summary": "Get a tree",
+ "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/git/trees#get-a-tree"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "tree_sha",
+ "description": "The SHA1 value or ref (branch or tag) name of the tree.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ {
+ "name": "recursive",
+ "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/git-tree"
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/git-tree-default-response"
+ },
+ "response-recursively-retrieving-a-tree": {
+ "$ref": "#/components/examples/git-tree-response-recursively-retrieving-a-tree"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "git",
+ "subcategory": "trees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks": {
+ "get": {
+ "summary": "List repository webhooks",
+ "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-webhooks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/hook"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create a repository webhook",
+ "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`."
+ },
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ }
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "default": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get a repository webhook",
+ "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a repository webhook",
+ "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "add_events": {
+ "type": "array",
+ "description": "Determines a list of events to be added to the list of events that the Hook triggers for.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "remove_events": {
+ "type": "array",
+ "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "default": true
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository webhook",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/config": {
+ "get": {
+ "summary": "Get a webhook configuration for a repository",
+ "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook-config-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a webhook configuration for a repository",
+ "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-webhook-config-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example of updating content type and URL",
+ "value": {
+ "content_type": "json",
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/webhook-config"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": {
+ "get": {
+ "summary": "List deliveries for a repository webhook",
+ "description": "Returns a list of webhook deliveries for a webhook configured in a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-webhook-deliveries",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/cursor"
+ },
+ {
+ "name": "redelivery",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/hook-delivery-item"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery-items"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": {
+ "get": {
+ "summary": "Get a delivery for a repository webhook",
+ "description": "Returns a delivery for a webhook configured in a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hook-delivery"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hook-delivery"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
+ "post": {
+ "summary": "Redeliver a delivery for a repository webhook",
+ "description": "Redeliver a webhook delivery for a webhook configured in a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/redeliver-webhook-delivery",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ },
+ {
+ "$ref": "#/components/parameters/delivery-id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping a repository webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": {
+ "post": {
+ "summary": "Test the push repository webhook",
+ "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/test-push-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/hook-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/import": {
+ "get": {
+ "summary": "Get an import status",
+ "description": "View the progress of an import.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-import-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/import"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/import"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ },
+ "put": {
+ "summary": "Start an import",
+ "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/start-import",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "vcs_url": {
+ "type": "string",
+ "description": "The URL of the originating repository."
+ },
+ "vcs": {
+ "type": "string",
+ "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.",
+ "enum": [
+ "subversion",
+ "git",
+ "mercurial",
+ "tfvc"
+ ]
+ },
+ "vcs_username": {
+ "type": "string",
+ "description": "If authentication is required, the username to provide to `vcs_url`."
+ },
+ "vcs_password": {
+ "type": "string",
+ "description": "If authentication is required, the password to provide to `vcs_url`."
+ },
+ "tfvc_project": {
+ "type": "string",
+ "description": "For a tfvc import, the name of the project that is being imported."
+ }
+ },
+ "required": [
+ "vcs_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "vcs": "subversion",
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "vcs_username": "octocat",
+ "vcs_password": "secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/import"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/import-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/spraints/socm/import",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update an import",
+ "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/update-import",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "vcs_username": {
+ "type": "string",
+ "description": "The username to provide to the originating repository."
+ },
+ "vcs_password": {
+ "type": "string",
+ "description": "The password to provide to the originating repository."
+ },
+ "vcs": {
+ "type": "string",
+ "description": "The type of version control system you are migrating from.",
+ "enum": [
+ "subversion",
+ "tfvc",
+ "git",
+ "mercurial"
+ ],
+ "example": "\"git\""
+ },
+ "tfvc_project": {
+ "type": "string",
+ "description": "For a tfvc import, the name of the project that is being imported.",
+ "example": "\"project1\""
+ }
+ },
+ "nullable": true
+ },
+ "examples": {
+ "example-1": {
+ "summary": "Update authentication for an import",
+ "value": {
+ "vcs_username": "octocat",
+ "vcs_password": "secret"
+ }
+ },
+ "example-2": {
+ "summary": "Updating the project choice",
+ "value": {
+ "vcs": "tfvc",
+ "tfvc_project": "project1",
+ "human_name": "project1 (tfs)"
+ }
+ },
+ "example-3": {
+ "summary": "Restarting an import"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/import"
+ },
+ "examples": {
+ "example-1": {
+ "$ref": "#/components/examples/import-example-1"
+ },
+ "example-2": {
+ "$ref": "#/components/examples/import-example-2"
+ },
+ "example-3": {
+ "$ref": "#/components/examples/import-response"
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Cancel an import",
+ "description": "Stop an import for a repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/cancel-import",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ }
+ },
+ "/repos/{owner}/{repo}/import/authors": {
+ "get": {
+ "summary": "Get commit authors",
+ "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-commit-authors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/since-user"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/porter-author"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/porter-author-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ }
+ },
+ "/repos/{owner}/{repo}/import/authors/{author_id}": {
+ "patch": {
+ "summary": "Map a commit author",
+ "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/map-commit-author",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "author_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "The new Git author email."
+ },
+ "name": {
+ "type": "string",
+ "description": "The new Git author name."
+ }
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "email": "hubot@github.com",
+ "name": "Hubot the Robot"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/porter-author"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/porter-author"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ }
+ },
+ "/repos/{owner}/{repo}/import/large_files": {
+ "get": {
+ "summary": "Get large files",
+ "description": "List files larger than 100MB found during the import\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-large-files",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/porter-large-file"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/porter-large-file-items"
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ }
+ },
+ "/repos/{owner}/{repo}/import/lfs": {
+ "patch": {
+ "summary": "Update Git LFS preference",
+ "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/set-lfs-preference",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "use_lfs": {
+ "type": "string",
+ "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.",
+ "enum": [
+ "opt_in",
+ "opt_out"
+ ]
+ }
+ },
+ "required": [
+ "use_lfs"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "use_lfs": "opt_in"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/import"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/import"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "503": {
+ "$ref": "#/components/responses/porter_maintenance"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "migrations",
+ "subcategory": "source-imports",
+ "deprecationDate": "2023-10-12",
+ "removalDate": "2024-04-12"
+ },
+ "deprecated": true
+ }
+ },
+ "/repos/{owner}/{repo}/installation": {
+ "get": {
+ "summary": "Get a repository installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-repo-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/installation"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/interaction-limits": {
+ "get": {
+ "summary": "Get interaction restrictions for a repository",
+ "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/get-restrictions-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "repos"
+ }
+ },
+ "put": {
+ "summary": "Set interaction restrictions for a repository",
+ "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/set-restrictions-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit"
+ },
+ "examples": {
+ "default": {
+ "summary": "Example request body",
+ "value": {
+ "limit": "collaborators_only",
+ "expiry": "one_day"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-2"
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "repos"
+ }
+ },
+ "delete": {
+ "summary": "Remove interaction restrictions for a repository",
+ "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/remove-restrictions-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "interactions",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/invitations": {
+ "get": {
+ "summary": "List repository invitations",
+ "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/invitations/{invitation_id}": {
+ "patch": {
+ "summary": "Update a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "string",
+ "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.",
+ "enum": [
+ "read",
+ "write",
+ "maintain",
+ "triage",
+ "admin"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example request body",
+ "value": {
+ "permissions": "write"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-invitation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-invitation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues": {
+ "get": {
+ "summary": "List repository issues",
+ "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#list-repository-issues"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "milestone",
+ "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "name": "assignee",
+ "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "creator",
+ "description": "The user that created the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "mentioned",
+ "description": "A user that's mentioned in the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/labels"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ },
+ "post": {
+ "summary": "Create an issue",
+ "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#create-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ],
+ "description": "The title of the issue."
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue."
+ },
+ "assignee": {
+ "type": "string",
+ "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_",
+ "nullable": true
+ },
+ "milestone": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer",
+ "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._"
+ }
+ ],
+ "nullable": true
+ },
+ "labels": {
+ "type": "array",
+ "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
+ "items": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ }
+ },
+ "assignees": {
+ "type": "array",
+ "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/comments": {
+ "get": {
+ "summary": "List issue comments for a repository",
+ "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/sort"
+ },
+ {
+ "name": "direction",
+ "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/comments/{comment_id}": {
+ "get": {
+ "summary": "Get an issue comment",
+ "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#get-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-comment"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ },
+ "patch": {
+ "summary": "Update an issue comment",
+ "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#update-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The contents of the comment."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-comment"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ },
+ "delete": {
+ "summary": "Delete an issue comment",
+ "description": "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.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": {
+ "get": {
+ "summary": "List reactions for an issue comment",
+ "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for an issue comment",
+ "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete an issue comment reaction",
+ "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/events": {
+ "get": {
+ "summary": "List issue events for a repository",
+ "description": "Lists events for a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue-event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-event-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/events/{event_id}": {
+ "get": {
+ "summary": "Get an issue event",
+ "description": "Gets a single event by the event id.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-event",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/events#get-an-issue-event"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "event_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue-event"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-event"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}": {
+ "get": {
+ "summary": "Get an issue",
+ "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#get-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ },
+ "patch": {
+ "summary": "Update an issue",
+ "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#update-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ],
+ "description": "The title of the issue.",
+ "nullable": true
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue.",
+ "nullable": true
+ },
+ "assignee": {
+ "type": "string",
+ "nullable": true,
+ "description": "Username to assign to this issue. **This field is deprecated.**"
+ },
+ "state": {
+ "type": "string",
+ "description": "The open or closed state of the issue.",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "not_planned",
+ "reopened"
+ ],
+ "nullable": true,
+ "description": "The reason for the state change. Ignored unless `state` is changed.",
+ "example": "not_planned"
+ },
+ "milestone": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer",
+ "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped."
+ }
+ ],
+ "nullable": true
+ },
+ "labels": {
+ "type": "array",
+ "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.",
+ "items": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ }
+ },
+ "assignees": {
+ "type": "array",
+ "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "state": "open",
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/assignees": {
+ "post": {
+ "summary": "Add assignees to an issue",
+ "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array",
+ "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ },
+ "delete": {
+ "summary": "Remove assignees from an issue",
+ "description": "Removes one or more assignees from an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array",
+ "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": {
+ "get": {
+ "summary": "Check if a user can be assigned to a issue",
+ "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/check-user-can-be-assigned-to-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "name": "assignee",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if `assignee` can be assigned to `issue_number`"
+ },
+ "404": {
+ "description": "Response if `assignee` can not be assigned to `issue_number`",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/comments": {
+ "get": {
+ "summary": "List issue comments",
+ "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#list-issue-comments"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create an issue comment",
+ "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The contents of the comment."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-comment"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/events": {
+ "get": {
+ "summary": "List issue events",
+ "description": "Lists all events for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/events#list-issue-events"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue-event-for-issue"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-event-for-issue-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/labels": {
+ "get": {
+ "summary": "List labels for an issue",
+ "description": "Lists all labels for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-on-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "post": {
+ "summary": "Add labels to an issue",
+ "description": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. ",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ },
+ {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "put": {
+ "summary": "Set labels for an issue",
+ "description": "Removes any previous labels and sets the new labels for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/set-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ },
+ {
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "delete": {
+ "summary": "Remove all labels from an issue",
+ "description": "Removes all labels from an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-all-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": {
+ "delete": {
+ "summary": "Remove a label from an issue",
+ "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items-2"
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "$ref": "#/components/responses/moved_permanently"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/lock": {
+ "put": {
+ "summary": "Lock an issue",
+ "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/lock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#lock-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "lock_reason": {
+ "type": "string",
+ "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`",
+ "enum": [
+ "off-topic",
+ "too heated",
+ "resolved",
+ "spam"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example of locking an issue as off-topic",
+ "value": {
+ "lock_reason": "off-topic"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ },
+ "delete": {
+ "summary": "Unlock an issue",
+ "description": "Users with push access can unlock an issue's conversation.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/unlock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": {
+ "get": {
+ "summary": "List reactions for an issue",
+ "description": "List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for an issue",
+ "description": "Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete an issue reaction",
+ "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/timeline": {
+ "get": {
+ "summary": "List timeline events for an issue",
+ "description": "List all timeline events for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-timeline",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/issue-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/timeline-issue-events"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/timeline-issue-events"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "timeline"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/keys": {
+ "get": {
+ "summary": "List deploy keys",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deploy-keys",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/deploy-key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deploy-key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deploy-keys",
+ "subcategory": "deploy-keys"
+ }
+ },
+ "post": {
+ "summary": "Create a deploy key",
+ "description": "You can create a read-only deploy key.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "A name for the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "The contents of the key."
+ },
+ "read_only": {
+ "type": "boolean",
+ "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\""
+ }
+ },
+ "required": [
+ "key"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deploy-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deploy-key"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/keys/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deploy-keys",
+ "subcategory": "deploy-keys"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/keys/{key_id}": {
+ "get": {
+ "summary": "Get a deploy key",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/key-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deploy-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/deploy-key"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deploy-keys",
+ "subcategory": "deploy-keys"
+ }
+ },
+ "delete": {
+ "summary": "Delete a deploy key",
+ "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/key-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "deploy-keys",
+ "subcategory": "deploy-keys"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/labels": {
+ "get": {
+ "summary": "List labels for a repository",
+ "description": "Lists all labels for a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#list-labels-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "post": {
+ "summary": "Create a label",
+ "description": "Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#create-a-label"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\""
+ },
+ "color": {
+ "type": "string",
+ "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the label. Must be 100 characters or fewer."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/label"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/labels/{name}": {
+ "get": {
+ "summary": "Get a label",
+ "description": "Gets a label using the given name.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#get-a-label"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/label"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "patch": {
+ "summary": "Update a label",
+ "description": "Updates a label using the given label name.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#update-a-label"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "new_name": {
+ "type": "string",
+ "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\""
+ },
+ "color": {
+ "type": "string",
+ "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the label. Must be 100 characters or fewer."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/label"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ },
+ "delete": {
+ "summary": "Delete a label",
+ "description": "Deletes a label using the given label name.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#delete-a-label"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/languages": {
+ "get": {
+ "summary": "List repository languages",
+ "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-languages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repository-languages"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/language"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/language"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/license": {
+ "get": {
+ "summary": "Get the license for a repository",
+ "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/git-ref"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/license-content"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/license-content"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "licenses",
+ "subcategory": "licenses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/merge-upstream": {
+ "post": {
+ "summary": "Sync a fork branch with the upstream repository",
+ "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/merge-upstream",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "The name of the branch which should be updated to match upstream."
+ }
+ },
+ "required": [
+ "branch"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "The branch has been successfully synced with the upstream repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/merged-upstream"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/merged-upstream"
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The branch could not be synced because of a merge conflict"
+ },
+ "422": {
+ "description": "The branch could not be synced for some other reason"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branches"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/merges": {
+ "post": {
+ "summary": "Merge a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/branches/branches#merge-a-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "string",
+ "description": "The name of the base branch that the head will be merged into."
+ },
+ "head": {
+ "type": "string",
+ "description": "The head to merge. This can be a branch name or a commit SHA1."
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Commit message to use for the merge commit. If omitted, a default message will be used."
+ }
+ },
+ "required": [
+ "base",
+ "head"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "base": "master",
+ "head": "cool_feature",
+ "commit_message": "Shipped cool_feature!"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Successful Response (The resulting merge commit)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when already merged"
+ },
+ "404": {
+ "description": "Not Found when the base or head does not exist"
+ },
+ "409": {
+ "description": "Conflict when there is a merge conflict"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "branches",
+ "subcategory": "branches"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/milestones": {
+ "get": {
+ "summary": "List milestones",
+ "description": "Lists milestones for a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-milestones",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/milestones#list-milestones"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "state",
+ "description": "The state of the milestone. Either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Either `due_on` or `completeness`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "due_on",
+ "completeness"
+ ],
+ "default": "due_on"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Either `asc` or `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "asc"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/milestone"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/milestone-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "milestones"
+ }
+ },
+ "post": {
+ "summary": "Create a milestone",
+ "description": "Creates a milestone.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/milestones#create-a-milestone"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the milestone."
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either `open` or `closed`.",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open"
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone."
+ },
+ "due_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/milestone"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/milestone"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "milestones"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/milestones/{milestone_number}": {
+ "get": {
+ "summary": "Get a milestone",
+ "description": "Gets a milestone using the given milestone number.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/milestones#get-a-milestone"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/milestone-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/milestone"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/milestone"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "milestones"
+ }
+ },
+ "patch": {
+ "summary": "Update a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/milestones#update-a-milestone"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/milestone-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the milestone."
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either `open` or `closed`.",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open"
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone."
+ },
+ "due_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/milestone"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/milestone"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "milestones"
+ }
+ },
+ "delete": {
+ "summary": "Delete a milestone",
+ "description": "Deletes a milestone using the given milestone number.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/milestones#delete-a-milestone"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/milestone-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "milestones"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": {
+ "get": {
+ "summary": "List labels for issues in a milestone",
+ "description": "Lists labels for issues in a milestone.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/milestone-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "issues",
+ "subcategory": "labels"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/notifications": {
+ "get": {
+ "summary": "List repository notifications for the authenticated user",
+ "description": "Lists all notifications for the current user in the specified repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-notifications-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/all"
+ },
+ {
+ "$ref": "#/components/parameters/participating"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/before"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/thread"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/thread-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ },
+ "put": {
+ "summary": "Mark repository notifications as read",
+ "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-repo-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "last_read_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "last_read_at": "2019-01-01T00:00:00Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background."
+ }
+ }
+ }
+ }
+ }
+ },
+ "205": {
+ "description": "Reset Content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "notifications"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages": {
+ "get": {
+ "summary": "Get a GitHub Pages site",
+ "description": "Gets information about a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ },
+ "post": {
+ "summary": "Create a GitHub Pages site",
+ "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The source branch and directory used to publish your Pages site.",
+ "nullable": true,
+ "properties": {
+ "build_type": {
+ "type": "string",
+ "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.",
+ "enum": [
+ "legacy",
+ "workflow"
+ ]
+ },
+ "source": {
+ "type": "object",
+ "description": "The source branch and directory used to publish your Pages site.",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "The repository branch used to publish your site's source files."
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/"
+ }
+ },
+ "required": [
+ "branch"
+ ]
+ }
+ },
+ "anyOf": [
+ {
+ "required": [
+ "source"
+ ]
+ },
+ {
+ "required": [
+ "build_type"
+ ]
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "source": {
+ "branch": "main",
+ "path": "/docs"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ },
+ "put": {
+ "summary": "Update information about a GitHub Pages site",
+ "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-information-about-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "cname": {
+ "type": "string",
+ "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"",
+ "nullable": true
+ },
+ "https_enforced": {
+ "type": "boolean",
+ "description": "Specify whether HTTPS should be enforced for the repository."
+ },
+ "build_type": {
+ "type": "string",
+ "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.",
+ "enum": [
+ "legacy",
+ "workflow"
+ ]
+ },
+ "source": {
+ "anyOf": [
+ {
+ "type": "string",
+ "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.",
+ "enum": [
+ "gh-pages",
+ "master",
+ "master /docs"
+ ]
+ },
+ {
+ "type": "object",
+ "description": "Update the source for the repository. Must include the branch name and path.",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "The repository branch used to publish your site's source files."
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.",
+ "enum": [
+ "/",
+ "/docs"
+ ]
+ }
+ },
+ "required": [
+ "branch",
+ "path"
+ ]
+ }
+ ]
+ }
+ },
+ "anyOf": [
+ {
+ "required": [
+ "build_type"
+ ]
+ },
+ {
+ "required": [
+ "source"
+ ]
+ },
+ {
+ "required": [
+ "cname"
+ ]
+ },
+ {
+ "required": [
+ "public"
+ ]
+ },
+ {
+ "required": [
+ "https_enforced"
+ ]
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "cname": "octocatblog.com",
+ "source": {
+ "branch": "main",
+ "path": "/"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a GitHub Pages site",
+ "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/builds": {
+ "get": {
+ "summary": "List GitHub Pages builds",
+ "description": "Lists builts of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pages-builds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#list-apiname-pages-builds"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/page-build"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page-build-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ },
+ "post": {
+ "summary": "Request a GitHub Pages build",
+ "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/request-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page-build-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page-build-status"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/builds/latest": {
+ "get": {
+ "summary": "Get latest Pages build",
+ "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#get-latest-pages-build"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page-build"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page-build"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/builds/{build_id}": {
+ "get": {
+ "summary": "Get GitHub Pages build",
+ "description": "Gets information about a GitHub Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#get-apiname-pages-build"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "build_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page-build"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page-build"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/deployments": {
+ "post": {
+ "summary": "Create a GitHub Pages deployment",
+ "description": "Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-pages-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The object used to create GitHub Pages deployment",
+ "properties": {
+ "artifact_id": {
+ "type": "number",
+ "description": "The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required."
+ },
+ "artifact_url": {
+ "type": "string",
+ "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required."
+ },
+ "environment": {
+ "type": "string",
+ "description": "The target environment for this GitHub Pages deployment.",
+ "default": "github-pages"
+ },
+ "pages_build_version": {
+ "type": "string",
+ "description": "A unique string that represents the version of the build for this deployment.",
+ "default": "GITHUB_SHA"
+ },
+ "oidc_token": {
+ "type": "string",
+ "description": "The OIDC token issued by GitHub Actions certifying the origin of the deployment."
+ }
+ },
+ "required": [
+ "pages_build_version",
+ "oidc_token"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "artifact_url": "https://downloadcontent/",
+ "environment": "github-pages",
+ "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251",
+ "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA",
+ "preview": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/page-deployment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/page-deployment"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": {
+ "get": {
+ "summary": "Get the status of a GitHub Pages deployment",
+ "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pages-deployment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pages-deployment-status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pages-deployment-status"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": {
+ "post": {
+ "summary": "Cancel a GitHub Pages deployment",
+ "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/cancel-pages-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pages-deployment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/health": {
+ "get": {
+ "summary": "Get a DNS health check for GitHub Pages",
+ "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-health-check",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pages-health-check"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pages-health-check"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Empty response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Custom domains are not available for GitHub Pages"
+ },
+ "422": {
+ "description": "There isn't a CNAME for this page"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pages",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/private-vulnerability-reporting": {
+ "put": {
+ "summary": "Enable private vulnerability reporting for a repository",
+ "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-private-vulnerability-reporting",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "422": {
+ "$ref": "#/components/responses/bad_request"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "delete": {
+ "summary": "Disable private vulnerability reporting for a repository",
+ "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-private-vulnerability-reporting",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "422": {
+ "$ref": "#/components/responses/bad_request"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/projects": {
+ "get": {
+ "summary": "List repository projects",
+ "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#list-repository-projects"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the projects to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-items-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ },
+ "post": {
+ "summary": "Create a repository project",
+ "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#create-a-repository-project"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the project."
+ },
+ "body": {
+ "type": "string",
+ "description": "The description of the project."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-3"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "410": {
+ "$ref": "#/components/responses/gone"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/properties/values": {
+ "get": {
+ "summary": "Get all custom property values for a repository",
+ "description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-custom-properties-values",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/custom-property-values"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "custom-properties"
+ }
+ },
+ "patch": {
+ "summary": "Create or update custom property values for a repository",
+ "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-or-update-custom-properties-values",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "type": "array",
+ "description": "A list of custom property names and associated values to apply to the repositories.",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ }
+ }
+ },
+ "required": [
+ "properties"
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/create-or-update-custom-properties-values"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "No Content when custom property values are successfully created or updated"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "custom-properties"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls": {
+ "get": {
+ "summary": "List pull requests",
+ "description": "Lists pull requests in a specified repository.\n\nDraft 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 [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.\n- **`application/vnd.github.patch`**: For more information, see \"[git-format-patch](https://git-scm.com/docs/git-format-patch)\" in the Git documentation.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#list-pull-requests"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "state",
+ "description": "Either `open`, `closed`, or `all` to filter by state.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "name": "head",
+ "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "base",
+ "description": "Filter pulls by base branch name. Example: `gh-pages`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "popularity",
+ "long-running"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ },
+ "post": {
+ "summary": "Create a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#create-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the new pull request. Required unless `issue` is specified."
+ },
+ "head": {
+ "type": "string",
+ "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`."
+ },
+ "head_repo": {
+ "type": "string",
+ "description": "The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.",
+ "format": "repo.nwo",
+ "example": "octo-org/octo-repo"
+ },
+ "base": {
+ "type": "string",
+ "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository."
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request."
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more."
+ },
+ "issue": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1,
+ "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified."
+ }
+ },
+ "required": [
+ "head",
+ "base"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/comments": {
+ "get": {
+ "summary": "List review comments in a repository",
+ "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "created_at"
+ ]
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": {
+ "get": {
+ "summary": "Get a review comment for a pull request",
+ "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-comment-2"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ },
+ "patch": {
+ "summary": "Update a review comment for a pull request",
+ "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The text of the reply to the review comment."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-comment-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a review comment for a pull request",
+ "description": "Deletes a review comment.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
+ "get": {
+ "summary": "List reactions for a pull request review comment",
+ "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a pull request review comment",
+ "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete a pull request comment reaction",
+ "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-pull-request-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}": {
+ "get": {
+ "summary": "Get a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#get-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ },
+ "patch": {
+ "summary": "Update a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the pull request."
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request."
+ },
+ "state": {
+ "type": "string",
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "base": {
+ "type": "string",
+ "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository."
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
+ "post": {
+ "summary": "Create a codespace from a pull request",
+ "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-with-pr-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "location": {
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
+ "type": "string"
+ },
+ "geo": {
+ "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.",
+ "type": "string",
+ "enum": [
+ "EuropeWest",
+ "SoutheastAsia",
+ "UsEast",
+ "UsWest"
+ ]
+ },
+ "client_ip": {
+ "description": "IP for location auto-detection when proxying a request",
+ "type": "string"
+ },
+ "machine": {
+ "description": "Machine type to use for this codespace",
+ "type": "string"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json config to use for this codespace",
+ "type": "string"
+ },
+ "multi_repo_permissions_opt_out": {
+ "description": "Whether to authorize requested permissions from devcontainer.json",
+ "type": "boolean"
+ },
+ "working_directory": {
+ "description": "Working directory for this codespace",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "Time in minutes before codespace stops from inactivity",
+ "type": "integer"
+ },
+ "display_name": {
+ "description": "Display name for this codespace",
+ "type": "string"
+ },
+ "retention_period_minutes": {
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
+ "type": "integer"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repository_id": 1,
+ "ref": "main"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when the codespace was successfully created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Response when the codespace creation partially failed but is being retried in the background",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
+ "get": {
+ "summary": "List review comments on a pull request",
+ "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/sort"
+ },
+ {
+ "name": "direction",
+ "description": "The direction to sort results. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create a review comment for a pull request",
+ "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The text of the review comment."
+ },
+ "commit_id": {
+ "type": "string",
+ "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`."
+ },
+ "path": {
+ "type": "string",
+ "description": "The relative path to the file that necessitates a comment."
+ },
+ "position": {
+ "type": "integer",
+ "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
+ "deprecated": true,
+ "x-github": {
+ "deprecationDate": "2022-11-01"
+ }
+ },
+ "side": {
+ "type": "string",
+ "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "line": {
+ "type": "integer",
+ "description": "**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to."
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation."
+ },
+ "start_side": {
+ "type": "string",
+ "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ "side"
+ ]
+ },
+ "in_reply_to": {
+ "type": "integer",
+ "example": 2,
+ "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored."
+ },
+ "subject_type": {
+ "type": "string",
+ "description": "The level at which the comment is targeted.",
+ "enum": [
+ "line",
+ "file"
+ ]
+ }
+ },
+ "required": [
+ "body",
+ "commit_id",
+ "path"
+ ]
+ },
+ "examples": {
+ "example-for-a-multi-line-comment": {
+ "summary": "Example for a multi-line comment",
+ "value": {
+ "body": "Great stuff!",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "path": "file1.txt",
+ "start_line": 1,
+ "start_side": "RIGHT",
+ "line": 2,
+ "side": "RIGHT"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ },
+ "examples": {
+ "example-for-a-multi-line-comment": {
+ "$ref": "#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": {
+ "post": {
+ "summary": "Create a reply for a review comment",
+ "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-reply-for-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The text of the review comment."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-comment"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": {
+ "get": {
+ "summary": "List commits on a pull request",
+ "description": "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 [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/files": {
+ "get": {
+ "summary": "List pull requests files",
+ "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-files",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#list-pull-requests-files"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/diff-entry"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/diff-entry-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/merge": {
+ "get": {
+ "summary": "Check if a pull request has been merged",
+ "description": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/check-if-merged",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if pull request has been merged"
+ },
+ "404": {
+ "description": "Not Found if pull request has not been merged"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ },
+ "put": {
+ "summary": "Merge a pull request",
+ "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_title": {
+ "type": "string",
+ "description": "Title for the automatic commit message."
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Extra detail to append to automatic commit message."
+ },
+ "sha": {
+ "type": "string",
+ "description": "SHA that pull request head must match to allow merge."
+ },
+ "merge_method": {
+ "type": "string",
+ "description": "The merge method to use.",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "response-if-merge-was-successful": {
+ "value": {
+ "commit_title": "Expand enum",
+ "commit_message": "Add a new value to the merge_method enum"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "if merge was successful",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-merge-result"
+ },
+ "examples": {
+ "response-if-merge-was-successful": {
+ "$ref": "#/components/examples/pull-request-merge-result-response-if-merge-was-successful"
+ }
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Method Not Allowed if merge cannot be performed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-merge-cannot-be-performed": {
+ "value": {
+ "message": "Pull Request is not mergeable"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict if sha was provided and pull request head did not match",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-sha-was-provided-and-pull-request-head-did-not-match": {
+ "value": {
+ "message": "Head branch was modified. Review and try the merge again."
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ "get": {
+ "summary": "Get all requested reviewers for a pull request",
+ "description": "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 [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review-request"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-pull-request-review-request"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "review-requests"
+ }
+ },
+ "post": {
+ "summary": "Request reviewers for a pull request",
+ "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/request-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array",
+ "description": "An array of user `login`s that will be requested.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_reviewers": {
+ "type": "array",
+ "description": "An array of team `slug`s that will be requested.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "anyOf": [
+ {
+ "required": [
+ "reviewers"
+ ]
+ },
+ {
+ "required": [
+ "team_reviewers"
+ ]
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-simple"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-request"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity if user is not a collaborator"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "review-requests"
+ }
+ },
+ "delete": {
+ "summary": "Remove requested reviewers from a pull request",
+ "description": "Removes review requests from a pull request for a given set of users and/or teams.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/remove-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array",
+ "description": "An array of user `login`s that will be removed.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_reviewers": {
+ "type": "array",
+ "description": "An array of team `slug`s that will be removed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "reviewers"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-simple"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-simple"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "review-requests"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": {
+ "get": {
+ "summary": "List reviews for a pull request",
+ "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-reviews",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The list of reviews returns in chronological order.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-review"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ },
+ "post": {
+ "summary": "Create a review for a pull request",
+ "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "commit_id": {
+ "type": "string",
+ "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value."
+ },
+ "body": {
+ "type": "string",
+ "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review."
+ },
+ "event": {
+ "type": "string",
+ "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ]
+ },
+ "comments": {
+ "type": "array",
+ "description": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The relative path to the file that necessitates a review comment."
+ },
+ "position": {
+ "type": "integer",
+ "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file."
+ },
+ "body": {
+ "type": "string",
+ "description": "Text of the review comment."
+ },
+ "line": {
+ "type": "integer",
+ "example": 28
+ },
+ "side": {
+ "type": "string",
+ "example": "RIGHT"
+ },
+ "start_line": {
+ "type": "integer",
+ "example": 26
+ },
+ "start_side": {
+ "type": "string",
+ "example": "LEFT"
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": {
+ "get": {
+ "summary": "Get a review for a pull request",
+ "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-4"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ },
+ "put": {
+ "summary": "Update a review for a pull request",
+ "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The body text of the pull request review."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "This is close to perfect! Please address the suggested inline change. And add more about this."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-5"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ },
+ "delete": {
+ "summary": "Delete a pending review for a pull request",
+ "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-pending-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": {
+ "get": {
+ "summary": "List comments for a pull request review",
+ "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-comments-for-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/review-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/review-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": {
+ "put": {
+ "summary": "Dismiss a review for a pull request",
+ "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/dismiss-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The message for the pull request review dismissal"
+ },
+ "event": {
+ "type": "string",
+ "example": "\"DISMISS\"",
+ "enum": [
+ "DISMISS"
+ ]
+ }
+ },
+ "required": [
+ "message"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "You are dismissed",
+ "event": "DISMISS"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-3"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
+ "post": {
+ "summary": "Submit a review for a pull request",
+ "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/submit-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ },
+ {
+ "$ref": "#/components/parameters/review-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The body text of the pull request review"
+ },
+ "event": {
+ "type": "string",
+ "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ]
+ }
+ },
+ "required": [
+ "event"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Here is the body for the review.",
+ "event": "REQUEST_CHANGES"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pull-request-review"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/pull-request-review-4"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "pulls",
+ "subcategory": "reviews"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": {
+ "put": {
+ "summary": "Update a pull request branch",
+ "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/pull-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "expected_head_sha": {
+ "type": "string",
+ "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "message": "Updating pull request branch.",
+ "url": "https://github.com/repos/octocat/Hello-World/pulls/53"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "pulls",
+ "subcategory": "pulls"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/readme": {
+ "get": {
+ "summary": "Get a repository README",
+ "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-readme",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#get-a-repository-readme"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the commit/branch/tag. Default: the repository’s default branch.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/content-file"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/content-file"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/readme/{dir}": {
+ "get": {
+ "summary": "Get a repository README for a directory",
+ "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-readme-in-directory",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "dir",
+ "description": "The alternate path to look for a README file",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ {
+ "name": "ref",
+ "description": "The name of the commit/branch/tag. Default: the repository’s default branch.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/content-file"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/content-file"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases": {
+ "get": {
+ "summary": "List releases",
+ "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-releases",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#list-releases"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/release"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ },
+ "post": {
+ "summary": "Create a release",
+ "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#create-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ "target_commitish": {
+ "type": "string",
+ "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release."
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag."
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
+ "default": false
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
+ "default": false
+ },
+ "discussion_category_name": {
+ "type": "string",
+ "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
+ },
+ "generate_release_notes": {
+ "type": "boolean",
+ "description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
+ "default": false
+ },
+ "make_latest": {
+ "type": "string",
+ "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.",
+ "enum": [
+ "true",
+ "false",
+ "legacy"
+ ],
+ "default": true
+ }
+ },
+ "required": [
+ "tag_name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if the discussion category name is invalid",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/assets/{asset_id}": {
+ "get": {
+ "summary": "Get a release asset",
+ "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/assets#get-a-release-asset"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/asset-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release-asset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release-asset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "302": {
+ "$ref": "#/components/responses/found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "assets"
+ }
+ },
+ "patch": {
+ "summary": "Update a release asset",
+ "description": "Users with push access to the repository can edit a release asset.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/assets#update-a-release-asset"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/asset-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The file name of the asset."
+ },
+ "label": {
+ "type": "string",
+ "description": "An alternate short description of the asset. Used in place of the filename."
+ },
+ "state": {
+ "type": "string",
+ "example": "\"uploaded\""
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release-asset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release-asset"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "assets"
+ }
+ },
+ "delete": {
+ "summary": "Delete a release asset",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/assets#delete-a-release-asset"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/asset-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "assets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/generate-notes": {
+ "post": {
+ "summary": "Generate release notes content for a release",
+ "description": "Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/generate-release-notes",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "The tag name for the release. This can be an existing tag or a new one."
+ },
+ "target_commitish": {
+ "type": "string",
+ "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists."
+ },
+ "previous_tag_name": {
+ "type": "string",
+ "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release."
+ },
+ "configuration_file_path": {
+ "type": "string",
+ "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used."
+ }
+ },
+ "required": [
+ "tag_name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Name and body of generated release notes",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release-notes-content"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release-notes-content"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/latest": {
+ "get": {
+ "summary": "Get the latest release",
+ "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#get-the-latest-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/tags/{tag}": {
+ "get": {
+ "summary": "Get a release by tag name",
+ "description": "Get a published release with the specified tag.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-by-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "tag",
+ "description": "tag parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/{release_id}": {
+ "get": {
+ "summary": "Get a release",
+ "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#get-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ },
+ "patch": {
+ "summary": "Update a release",
+ "description": "Users with push access to the repository can edit a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#update-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ "target_commitish": {
+ "type": "string",
+ "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release."
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag."
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "`true` makes the release a draft, and `false` publishes the release."
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release."
+ },
+ "make_latest": {
+ "type": "string",
+ "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.",
+ "enum": [
+ "true",
+ "false",
+ "legacy"
+ ],
+ "default": true
+ },
+ "discussion_category_name": {
+ "type": "string",
+ "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if the discussion category name is invalid",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ },
+ "delete": {
+ "summary": "Delete a release",
+ "description": "Users with push access to the repository can delete a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/releases#delete-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "releases"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/{release_id}/assets": {
+ "get": {
+ "summary": "List release assets",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-release-assets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/assets#list-release-assets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/release-asset"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/release-asset-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "assets"
+ }
+ },
+ "post": {
+ "summary": "Upload a release asset",
+ "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/upload-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/releases/assets#upload-a-release-asset"
+ },
+ "servers": [
+ {
+ "url": "https://uploads.github.com",
+ "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint"
+ }
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "label",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "type": "string",
+ "format": "binary",
+ "description": "The raw file data"
+ },
+ "examples": {
+ "default": {
+ "value": "@example.zip"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response for successful upload",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/release-asset"
+ },
+ "examples": {
+ "response-for-successful-upload": {
+ "$ref": "#/components/examples/release-asset-response-for-successful-upload"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Response if you upload an asset with the same filename as another uploaded asset"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "releases",
+ "subcategory": "assets"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/{release_id}/reactions": {
+ "get": {
+ "summary": "List reactions for a release",
+ "description": "List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "laugh",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a release",
+ "description": "Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.",
+ "enum": [
+ "+1",
+ "laugh",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete a release reaction",
+ "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/delete-for-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/release-id"
+ },
+ {
+ "$ref": "#/components/parameters/reaction-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "reactions",
+ "subcategory": "reactions"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/rules/branches/{branch}": {
+ "get": {
+ "summary": "Get rules for a branch",
+ "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-branch-rules",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#get-rules-for-a-branch"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/branch"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule-detailed"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-rule-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/rulesets": {
+ "get": {
+ "summary": "Get all repository rulesets",
+ "description": "Get all the rulesets for a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-repo-rulesets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#get-all-repository-rulesets"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "name": "includes_parents",
+ "description": "Include rulesets configured at higher levels that apply to this repository",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-ruleset-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "post": {
+ "summary": "Create a repository ruleset",
+ "description": "Create a ruleset for a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-repo-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#create-a-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "description": "Request body",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the ruleset."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the ruleset.",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ },
+ "enforcement": {
+ "$ref": "#/components/schemas/repository-rule-enforcement"
+ },
+ "bypass_actors": {
+ "type": "array",
+ "description": "The actors that can bypass the rules in this ruleset",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
+ }
+ },
+ "conditions": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ "rules": {
+ "type": "array",
+ "description": "An array of rules within the ruleset.",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "enforcement"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "super cool ruleset",
+ "target": "branch",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/rulesets/rule-suites": {
+ "get": {
+ "summary": "List repository rule suites",
+ "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-repo-rule-suites",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/ref-in-query"
+ },
+ {
+ "$ref": "#/components/parameters/time-period"
+ },
+ {
+ "$ref": "#/components/parameters/actor-name-in-query"
+ },
+ {
+ "$ref": "#/components/parameters/rule-suite-result"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/rule-suites"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/rule-suite-items"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rule-suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": {
+ "get": {
+ "summary": "Get a repository rule suite",
+ "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-repo-rule-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/rule-suite-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/rule-suite"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/rule-suite"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rule-suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/rulesets/{ruleset_id}": {
+ "get": {
+ "summary": "Get a repository ruleset",
+ "description": "Get a ruleset for a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-repo-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#get-a-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "includes_parents",
+ "description": "Include rulesets configured at higher levels that apply to this repository",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "put": {
+ "summary": "Update a repository ruleset",
+ "description": "Update a ruleset for a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-repo-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#update-a-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Request body",
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the ruleset."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the ruleset.",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ },
+ "enforcement": {
+ "$ref": "#/components/schemas/repository-rule-enforcement"
+ },
+ "bypass_actors": {
+ "type": "array",
+ "description": "The actors that can bypass the rules in this ruleset",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
+ }
+ },
+ "conditions": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ "rules": {
+ "description": "An array of rules within the ruleset.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "super cool ruleset",
+ "target": "branch",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-ruleset"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository ruleset",
+ "description": "Delete a ruleset for a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-repo-ruleset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "rules"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ruleset_id",
+ "description": "The ID of the ruleset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/secret-scanning/alerts": {
+ "get": {
+ "summary": "List secret scanning alerts for a repository",
+ "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "secret-scanning"
+ ],
+ "operationId": "secret-scanning/list-alerts-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-state"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-secret-type"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-resolution"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-sort"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo"
+ },
+ {
+ "$ref": "#/components/parameters/secret-scanning-alert-validity"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/secret-scanning-alert"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-alert-list"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Repository is public or secret scanning is disabled for the repository"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": {
+ "get": {
+ "summary": "Get a secret scanning alert",
+ "description": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "secret-scanning"
+ ],
+ "operationId": "secret-scanning/get-alert",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/secret-scanning-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-alert-open"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ },
+ "patch": {
+ "summary": "Update a secret scanning alert",
+ "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "operationId": "secret-scanning/update-alert",
+ "tags": [
+ "secret-scanning"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "$ref": "#/components/schemas/secret-scanning-alert-state"
+ },
+ "resolution": {
+ "$ref": "#/components/schemas/secret-scanning-alert-resolution"
+ },
+ "resolution_comment": {
+ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment"
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/secret-scanning-alert"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-alert-resolved"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request, resolution comment is invalid or the resolution was not changed."
+ },
+ "404": {
+ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
+ },
+ "422": {
+ "description": "State does not match the resolution or resolution comment"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "enabledForGitHubApps": true,
+ "githubCloudOnly": false,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": {
+ "get": {
+ "summary": "List locations for a secret scanning alert",
+ "description": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.",
+ "tags": [
+ "secret-scanning"
+ ],
+ "operationId": "secret-scanning/list-locations-for-alert",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/alert-number"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of locations where the secret was detected",
+ "items": {
+ "$ref": "#/components/schemas/secret-scanning-location"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-location-list"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "secret-scanning",
+ "subcategory": "secret-scanning"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/security-advisories": {
+ "get": {
+ "summary": "List repository security advisories",
+ "description": "Lists security advisories in a repository.\n\nThe authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/list-repository-advisories",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "published"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/pagination-before"
+ },
+ {
+ "$ref": "#/components/parameters/pagination-after"
+ },
+ {
+ "name": "per_page",
+ "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ {
+ "name": "state",
+ "description": "Filter by state of the repository advisories. Only advisories of this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "triage",
+ "draft",
+ "published",
+ "closed"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-advisory"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/list-repository-advisories"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ },
+ "post": {
+ "summary": "Create a repository security advisory",
+ "description": "Creates a new repository security advisory.\n\nIn order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/create-repository-advisory",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory-create"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "summary": "A new important advisory",
+ "description": "A more in-depth description of what the problem is.",
+ "severity": "high",
+ "cve_id": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "name": "a-package",
+ "ecosystem": "npm"
+ },
+ "vulnerable_version_range": "< 1.0.0",
+ "patched_versions": "1.0.0",
+ "vulnerable_functions": [
+ "important_function"
+ ]
+ }
+ ],
+ "cwe_ids": [
+ "CWE-1101",
+ "CWE-20"
+ ],
+ "credits": [
+ {
+ "login": "monalisa",
+ "type": "reporter"
+ },
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ]
+ }
+ },
+ "withVectorString": {
+ "value": {
+ "summary": "A new important advisory",
+ "description": "A more in-depth description of what the problem is.",
+ "cvss_vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L",
+ "cve_id": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "name": "a-package",
+ "ecosystem": "npm"
+ },
+ "vulnerable_version_range": "< 1.0.0",
+ "patched_versions": "1.0.0",
+ "vulnerable_functions": [
+ "important_function"
+ ]
+ }
+ ],
+ "cwe_ids": [
+ "CWE-1101",
+ "CWE-20"
+ ],
+ "credits": [
+ {
+ "login": "monalisa",
+ "type": "reporter"
+ },
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ]
+ }
+ },
+ "minimal": {
+ "value": {
+ "summary": "A new important advisory",
+ "description": "A more in-depth description of what the problem is.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "npm"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-advisory"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/security-advisories/reports": {
+ "post": {
+ "summary": "Privately report a security vulnerability",
+ "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/create-private-vulnerability-report",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/private-vulnerability-report-create"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "summary": "A newly discovered vulnerability",
+ "description": "A more in-depth description of what the problem is.",
+ "severity": "high",
+ "vulnerabilities": [
+ {
+ "package": {
+ "name": "a-package",
+ "ecosystem": "npm"
+ },
+ "vulnerable_version_range": "< 1.0.0",
+ "patched_versions": "1.0.0",
+ "vulnerable_functions": [
+ "important_function"
+ ]
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-advisory-pvr"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
+ "get": {
+ "summary": "Get a repository security advisory",
+ "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nAnyone can access any published security advisory on a public repository.\n\nThe authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a\ncollaborator on the security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/get-repository-advisory",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/ghsa_id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-advisory"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ },
+ "patch": {
+ "summary": "Update a repository security advisory",
+ "description": "Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nIn order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/update-repository-advisory",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/ghsa_id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory-update"
+ },
+ "examples": {
+ "default": {
+ "summary": "Updating the severity and state.",
+ "value": {
+ "severity": "critical",
+ "state": "published"
+ }
+ },
+ "add_credit": {
+ "summary": "To add a credit to an advisory, send the whole array of values.",
+ "value": {
+ "credits": [
+ {
+ "login": "monauser",
+ "type": "remediation_developer"
+ }
+ ]
+ }
+ },
+ "update_vvrs": {
+ "summary": "To add vulnerable versions, include existing versions in the array.",
+ "value": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ]
+ },
+ "invalid_state_transition": {
+ "summary": "Example of an invalid state transition, from `published` to `draft`.",
+ "value": {
+ "state": "draft"
+ }
+ },
+ "update_severity_with_cvss_set": {
+ "summary": "Severity cannot be updated when the CVSS is already set.",
+ "value": {
+ "severity": "low"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-advisory"
+ },
+ "add_credit": {
+ "$ref": "#/components/examples/repository-advisory"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/validation-error"
+ },
+ "examples": {
+ "invalid_state_transition": {
+ "value": {
+ "message": "Invalid state transition from `published` to `draft`."
+ }
+ },
+ "update_severity_with_cvss_set": {
+ "value": {
+ "message": "Cannot update severity value when CVSS is set."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": {
+ "post": {
+ "summary": "Request a CVE for a repository security advisory",
+ "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/create-repository-advisory-cve-request",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/ghsa_id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": {
+ "post": {
+ "summary": "Create a temporary private fork",
+ "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n**Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.",
+ "tags": [
+ "security-advisories"
+ ],
+ "operationId": "security-advisories/create-fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/ghsa_id"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "security-advisories",
+ "subcategory": "repository-advisories"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stargazers": {
+ "get": {
+ "summary": "List stargazers",
+ "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-stargazers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#list-stargazers"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/stargazer"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/simple-user-items-default-response"
+ },
+ "alternative-response-with-star-creation-timestamps": {
+ "$ref": "#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/code_frequency": {
+ "get": {
+ "summary": "Get the weekly commit activity",
+ "description": "\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n**Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains\n10,000 or more commits, a 422 status code will be returned.\n",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-code-frequency-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-frequency-stat"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-frequency-stat-items"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ },
+ "422": {
+ "description": "Repository contains more than 10,000 commits"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/commit_activity": {
+ "get": {
+ "summary": "Get the last year of commit activity",
+ "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-activity-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit-activity"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-activity-items"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/contributors": {
+ "get": {
+ "summary": "Get all contributor commit activity",
+ "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n**Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-contributors-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/contributor-activity"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/contributor-activity-items"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/participation": {
+ "get": {
+ "summary": "Get the weekly commit count",
+ "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\nThe most recent week is seven days ago at UTC midnight to today at UTC midnight.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-participation-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The array order is oldest week (index 0) to most recent week.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/participation-stats"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/participation-stats"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/punch_card": {
+ "get": {
+ "summary": "Get the hourly commit count for each day",
+ "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-punch-card-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-frequency-stat"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-frequency-stat-items-2"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "$ref": "#/components/responses/no_content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/statuses/{sha}": {
+ "post": {
+ "summary": "Create a commit status",
+ "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/commits/statuses#create-a-commit-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state of the status.",
+ "enum": [
+ "error",
+ "failure",
+ "pending",
+ "success"
+ ]
+ },
+ "target_url": {
+ "type": "string",
+ "nullable": true,
+ "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true,
+ "description": "A short description of the status."
+ },
+ "context": {
+ "type": "string",
+ "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.",
+ "default": "default"
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/status"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/status"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "commits",
+ "subcategory": "statuses"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/subscribers": {
+ "get": {
+ "summary": "List watchers",
+ "description": "Lists the people watching the specified repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watchers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#list-watchers"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/subscription": {
+ "get": {
+ "summary": "Get a repository subscription",
+ "description": "Gets information about whether the authenticated user is subscribed to the repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#get-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "if you subscribe to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-subscription"
+ },
+ "examples": {
+ "response-if-you-subscribe-to-the-repository": {
+ "$ref": "#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if you don't subscribe to the repository"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ },
+ "put": {
+ "summary": "Set a repository subscription",
+ "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#set-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "subscribed": {
+ "type": "boolean",
+ "description": "Determines if notifications should be received from this repository."
+ },
+ "ignored": {
+ "type": "boolean",
+ "description": "Determines if all notifications should be blocked from this repository."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "subscribed": true,
+ "ignored": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository-subscription"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-subscription"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository subscription",
+ "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#delete-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/tags": {
+ "get": {
+ "summary": "List repository tags",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-tags",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repository-tags"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/tag"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/tag-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/tags/protection": {
+ "get": {
+ "summary": "List tag protection states for a repository",
+ "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-tag-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/tag-protection"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/tag-protection-items"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "tags"
+ }
+ },
+ "post": {
+ "summary": "Create a tag protection state for a repository",
+ "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-tag-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "pattern": {
+ "type": "string",
+ "description": "An optional glob pattern to match against when enforcing tag protection."
+ }
+ },
+ "required": [
+ "pattern"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "pattern": "v1.*"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tag-protection"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/tag-protection"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "tags"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": {
+ "delete": {
+ "summary": "Delete a tag protection state for a repository",
+ "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-tag-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/tag-protection-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "tags"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/tarball/{ref}": {
+ "get": {
+ "summary": "Download a repository archive (tar)",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar"
+ },
+ "operationId": "repos/download-tarball-archive",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "x-multi-segment": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/teams": {
+ "get": {
+ "summary": "List repository teams",
+ "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repository-teams"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/topics": {
+ "get": {
+ "summary": "Get all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#get-all-repository-topics"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/topic"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/topic"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "put": {
+ "summary": "Replace all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/replace-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#replace-all-repository-topics"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/topic"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/topic"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/traffic/clones": {
+ "get": {
+ "summary": "Get repository clones",
+ "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-clones",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/traffic#get-repository-clones"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/clone-traffic"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/clone-traffic"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "traffic"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/traffic/popular/paths": {
+ "get": {
+ "summary": "Get top referral paths",
+ "description": "Get the top 10 popular contents over the last 14 days.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-top-paths",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/traffic#get-top-referral-paths"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/content-traffic"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/content-traffic-items"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "traffic"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/traffic/popular/referrers": {
+ "get": {
+ "summary": "Get top referral sources",
+ "description": "Get the top 10 referrers over the last 14 days.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-top-referrers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/traffic#get-top-referral-sources"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/referrer-traffic"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/referrer-traffic-items"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "traffic"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/traffic/views": {
+ "get": {
+ "summary": "Get page views",
+ "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-views",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/metrics/traffic#get-page-views"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "$ref": "#/components/parameters/per"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/view-traffic"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/view-traffic"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "metrics",
+ "subcategory": "traffic"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/transfer": {
+ "post": {
+ "summary": "Transfer a repository",
+ "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/transfer",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#transfer-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "new_owner": {
+ "type": "string",
+ "description": "The username or organization name the repository will be transferred to."
+ },
+ "new_name": {
+ "type": "string",
+ "description": "The new name to be given to the repository."
+ },
+ "team_ids": {
+ "type": "array",
+ "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "new_owner"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ],
+ "new_name": "octorepo"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/vulnerability-alerts": {
+ "get": {
+ "summary": "Check if vulnerability alerts are enabled for a repository",
+ "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/check-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if repository is enabled with vulnerability alerts"
+ },
+ "404": {
+ "description": "Not Found if repository is not enabled with vulnerability alerts"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "put": {
+ "summary": "Enable vulnerability alerts",
+ "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "delete": {
+ "summary": "Disable vulnerability alerts",
+ "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/zipball/{ref}": {
+ "get": {
+ "summary": "Download a repository archive (zip)",
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip"
+ },
+ "operationId": "repos/download-zipball-archive",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "x-multi-segment": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response",
+ "headers": {
+ "Location": {
+ "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ }
+ },
+ "/repos/{template_owner}/{template_repo}/generate": {
+ "post": {
+ "summary": "Create a repository using a template",
+ "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-using-template",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template"
+ },
+ "parameters": [
+ {
+ "name": "template_owner",
+ "description": "The account owner of the template repository. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "template_repo",
+ "description": "The name of the template repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "owner": {
+ "type": "string",
+ "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the new repository."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the new repository."
+ },
+ "include_all_branches": {
+ "type": "boolean",
+ "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "default": false
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "default": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repositories": {
+ "get": {
+ "summary": "List public repositories",
+ "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-public-repositories"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since-repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/public-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/repositories/{repository_id}/environments/{environment_name}/secrets": {
+ "get": {
+ "summary": "List environment secrets",
+ "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-environment-secrets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
+ "get": {
+ "summary": "Get an environment public key",
+ "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-environment-public-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get an environment secret",
+ "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-environment-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update an environment secret",
+ "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-or-update-environment-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ }
+ },
+ "required": [
+ "encrypted_value",
+ "key_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when updating a secret"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete an environment secret",
+ "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-environment-secret",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Default response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/repositories/{repository_id}/environments/{environment_name}/variables": {
+ "get": {
+ "summary": "List environment variables",
+ "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/list-environment-variables",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#list-environment-variables"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/variables-per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "variables"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "variables": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/actions-variable"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-variables-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "post": {
+ "summary": "Create an environment variable",
+ "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/create-environment-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
+ "get": {
+ "summary": "Get an environment variable",
+ "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/get-environment-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-variable"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-variable"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "patch": {
+ "summary": "Update an environment variable",
+ "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/update-environment-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the variable."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the variable."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ },
+ "delete": {
+ "summary": "Delete an environment variable",
+ "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "actions"
+ ],
+ "operationId": "actions/delete-environment-variable",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/repository-id"
+ },
+ {
+ "$ref": "#/components/parameters/variable-name"
+ },
+ {
+ "$ref": "#/components/parameters/environment-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "actions",
+ "subcategory": "variables"
+ }
+ }
+ },
+ "/search/code": {
+ "get": {
+ "summary": "Search code",
+ "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-code"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "deprecated": true,
+ "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "indexed"
+ ]
+ }
+ },
+ {
+ "name": "order",
+ "description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
+ "in": "query",
+ "deprecated": true,
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "desc",
+ "asc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/code-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/code-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/commits": {
+ "get": {
+ "summary": "Search commits",
+ "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-commits"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "author-date",
+ "committer-date"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/order"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/commit-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/issues": {
+ "get": {
+ "summary": "Search issues and pull requests",
+ "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/issues-and-pull-requests",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-issues-and-pull-requests"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "comments",
+ "reactions",
+ "reactions-+1",
+ "reactions--1",
+ "reactions-smile",
+ "reactions-thinking_face",
+ "reactions-heart",
+ "reactions-tada",
+ "interactions",
+ "created",
+ "updated"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/order"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/labels": {
+ "get": {
+ "summary": "Search labels",
+ "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-labels"
+ },
+ "parameters": [
+ {
+ "name": "repository_id",
+ "description": "The id of the repository.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "q",
+ "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/order"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/label-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/label-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/repositories": {
+ "get": {
+ "summary": "Search repositories",
+ "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-repositories"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "stars",
+ "forks",
+ "help-wanted-issues",
+ "updated"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/order"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repo-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/topics": {
+ "get": {
+ "summary": "Search topics",
+ "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-topics"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/topic-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/topic-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/search/users": {
+ "get": {
+ "summary": "Search users",
+ "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/search/search#search-users"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "followers",
+ "repositories",
+ "joined"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/order"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/user-search-result-item"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-search-result-item-paginated"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update a team (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#update-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the team."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team."
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response when the updated information already exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-full"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete a team (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions": {
+ "get": {
+ "summary": "List discussions (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-discussions-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-discussion"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create a discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}": {
+ "get": {
+ "summary": "Get a discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update a discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete a discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "get": {
+ "summary": "List discussion comments (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-discussion-comments-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create a discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The discussion comment's body text."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "get": {
+ "summary": "Get a discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update a discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The discussion comment's body text."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-discussion-comment"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-discussion-comment-2"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete a discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/delete-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-team-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-21",
+ "deprecationDate": "2020-02-26",
+ "category": "reactions",
+ "subcategory": "reactions"
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion comment (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-team-discussion-comment-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "$ref": "#/components/parameters/comment-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-21",
+ "deprecationDate": "2020-02-26",
+ "category": "reactions",
+ "subcategory": "reactions"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-team-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/reaction"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-21",
+ "deprecationDate": "2020-02-26",
+ "category": "reactions",
+ "subcategory": "reactions"
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-team-discussion-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/discussion-number"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/reaction"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/reaction"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "removalDate": "2021-02-21",
+ "deprecationDate": "2020-02-26",
+ "category": "reactions",
+ "subcategory": "reactions"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/invitations": {
+ "get": {
+ "summary": "List pending team invitations (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/members": {
+ "get": {
+ "summary": "List team members (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-members-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#list-team-members-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/members/{username}": {
+ "get": {
+ "summary": "Get team member (Legacy)",
+ "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#get-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "if user is a member"
+ },
+ "404": {
+ "description": "if user is not a member"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ },
+ "put": {
+ "summary": "Add team member (Legacy)",
+ "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#add-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "description": "Not Found if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Remove team member (Legacy)",
+ "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#remove-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "description": "Not Found if team synchronization is setup"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-membership-for-user-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-membership"
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ },
+ "put": {
+ "summary": "Add or update team membership for a user (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-membership-for-user-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Assign the member role for a user in a team",
+ "value": {
+ "role": "member"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-membership"
+ },
+ "examples": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Remove team membership for a user (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\n**Note:** When 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 team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-membership-for-user-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "if team synchronization is set up"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/projects": {
+ "get": {
+ "summary": "List team projects (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-projects-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-project"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-project-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/projects/{project_id}": {
+ "get": {
+ "summary": "Check team permissions for a project (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-project-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-project"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found if project is not managed by this team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "put": {
+ "summary": "Add or update team project permissions (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-project-permissions-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example of setting permission to read",
+ "value": {
+ "permission": "read"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if the project is not owned by the organization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
+ "value": {
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Remove a project from a team (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-project-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/project-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/repos": {
+ "get": {
+ "summary": "List team repositories (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-repos-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/repos/{owner}/{repo}": {
+ "get": {
+ "summary": "Check team permissions for a repository (Legacy)",
+ "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-repo-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Alternative response with extra repository information",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/team-repository"
+ },
+ "examples": {
+ "alternative-response-with-extra-repository-information": {
+ "$ref": "#/components/examples/team-repository-alternative-response-with-extra-repository-information"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response if repository is managed by this team"
+ },
+ "404": {
+ "description": "Not Found if repository is not managed by this team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "put": {
+ "summary": "Add or update team repository permissions (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-repo-permissions-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example of setting permission to pull",
+ "value": {
+ "permission": "push"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Remove a repository from a team (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf 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.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-repo-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/teams/{team_id}/teams": {
+ "get": {
+ "summary": "List child teams (Legacy)",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-child-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-child-teams-legacy"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/team-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "if child teams exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "examples": {
+ "response-if-child-teams-exist": {
+ "$ref": "#/components/examples/team-items-response-if-child-teams-exist"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "teams"
+ },
+ "deprecated": true
+ }
+ },
+ "/user": {
+ "get": {
+ "summary": "Get the authenticated user",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/users#get-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/private-user"
+ },
+ {
+ "$ref": "#/components/schemas/public-user"
+ }
+ ]
+ },
+ "examples": {
+ "response-with-public-and-private-profile-information": {
+ "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information"
+ },
+ "response-with-public-profile-information": {
+ "$ref": "#/components/examples/private-user-response-with-public-profile-information"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "users"
+ }
+ },
+ "patch": {
+ "summary": "Update the authenticated user",
+ "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/update-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/users#update-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The new name of the user.",
+ "type": "string",
+ "example": "Omar Jahandar"
+ },
+ "email": {
+ "description": "The publicly visible email address of the user.",
+ "type": "string",
+ "example": "omar@example.com"
+ },
+ "blog": {
+ "description": "The new blog URL of the user.",
+ "type": "string",
+ "example": "blog.example.com"
+ },
+ "twitter_username": {
+ "description": "The new Twitter username of the user.",
+ "type": "string",
+ "example": "therealomarj",
+ "nullable": true
+ },
+ "company": {
+ "description": "The new company of the user.",
+ "type": "string",
+ "example": "Acme corporation"
+ },
+ "location": {
+ "description": "The new location of the user.",
+ "type": "string",
+ "example": "Berlin, Germany"
+ },
+ "hireable": {
+ "description": "The new hiring availability of the user.",
+ "type": "boolean"
+ },
+ "bio": {
+ "description": "The new short biography of the user.",
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Example of updating blog and name",
+ "value": {
+ "blog": "https://github.com/blog",
+ "name": "monalisa octocat"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/private-user"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/private-user"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/blocks": {
+ "get": {
+ "summary": "List users blocked by the authenticated user",
+ "description": "List the users you've blocked on your personal account.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-blocked-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "blocking"
+ }
+ }
+ },
+ "/user/blocks/{username}": {
+ "get": {
+ "summary": "Check if a user is blocked by the authenticated user",
+ "description": "Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-blocked",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "If the user is blocked"
+ },
+ "404": {
+ "description": "If the user is not blocked",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "blocking"
+ }
+ },
+ "put": {
+ "summary": "Block a user",
+ "description": "Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/block",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/blocking#block-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "blocking"
+ }
+ },
+ "delete": {
+ "summary": "Unblock a user",
+ "description": "Unblocks the given user and returns a 204.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/unblock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/blocking#unblock-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "blocking"
+ }
+ }
+ },
+ "/user/codespaces": {
+ "get": {
+ "summary": "List codespaces for the authenticated user",
+ "description": "Lists the authenticated user's codespaces.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/repository-id-in-query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "codespaces"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "codespaces": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-list"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ },
+ "post": {
+ "summary": "Create a codespace for the authenticated user",
+ "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "repository_id"
+ ],
+ "properties": {
+ "repository_id": {
+ "description": "Repository id for this codespace",
+ "type": "integer"
+ },
+ "ref": {
+ "description": "Git ref (typically a branch name) for this codespace",
+ "type": "string"
+ },
+ "location": {
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
+ "type": "string"
+ },
+ "geo": {
+ "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.",
+ "type": "string",
+ "enum": [
+ "EuropeWest",
+ "SoutheastAsia",
+ "UsEast",
+ "UsWest"
+ ]
+ },
+ "client_ip": {
+ "description": "IP for location auto-detection when proxying a request",
+ "type": "string"
+ },
+ "machine": {
+ "description": "Machine type to use for this codespace",
+ "type": "string"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json config to use for this codespace",
+ "type": "string"
+ },
+ "multi_repo_permissions_opt_out": {
+ "description": "Whether to authorize requested permissions from devcontainer.json",
+ "type": "boolean"
+ },
+ "working_directory": {
+ "description": "Working directory for this codespace",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "Time in minutes before codespace stops from inactivity",
+ "type": "integer"
+ },
+ "display_name": {
+ "description": "Display name for this codespace",
+ "type": "string"
+ },
+ "retention_period_minutes": {
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
+ "type": "integer"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pull_request"
+ ],
+ "properties": {
+ "pull_request": {
+ "required": [
+ "pull_request_number",
+ "repository_id"
+ ],
+ "description": "Pull request number for this codespace",
+ "type": "object",
+ "properties": {
+ "pull_request_number": {
+ "description": "Pull request number",
+ "type": "integer"
+ },
+ "repository_id": {
+ "description": "Repository id for this codespace",
+ "type": "integer"
+ }
+ }
+ },
+ "location": {
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
+ "type": "string"
+ },
+ "geo": {
+ "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.",
+ "type": "string",
+ "enum": [
+ "EuropeWest",
+ "SoutheastAsia",
+ "UsEast",
+ "UsWest"
+ ]
+ },
+ "machine": {
+ "description": "Machine type to use for this codespace",
+ "type": "string"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json config to use for this codespace",
+ "type": "string"
+ },
+ "working_directory": {
+ "description": "Working directory for this codespace",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "Time in minutes before codespace stops from inactivity",
+ "type": "integer"
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repository_id": 1,
+ "ref": "main",
+ "geo": "UsWest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response when the codespace was successfully created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Response when the codespace creation partially failed but is being retried in the background",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/secrets": {
+ "get": {
+ "summary": "List secrets for the authenticated user",
+ "description": "Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-secrets-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "secrets"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespaces-secret"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repo-codespaces-secret-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/user/codespaces/secrets/public-key": {
+ "get": {
+ "summary": "Get public key for the authenticated user",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-public-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user"
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-user-public-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespaces-user-public-key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/user/codespaces/secrets/{secret_name}": {
+ "get": {
+ "summary": "Get a secret for the authenticated user",
+ "description": "Gets a development environment secret available to a user's codespaces without revealing its encrypted value.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespaces-secret"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-codespaces-secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Create or update a secret for the authenticated user",
+ "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/create-or-update-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "encrypted_value": {
+ "type": "string",
+ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
+ },
+ "key_id": {
+ "type": "string",
+ "description": "ID of the key you used to encrypt the secret."
+ },
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.",
+ "items": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "key_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "encrypted_value": "c2VjcmV0",
+ "key_id": "012345678912345678",
+ "selected_repository_ids": [
+ "1234567",
+ "2345678"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response after successfully creating a secret",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/empty-object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response after successfully updating a secret"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Delete a secret for the authenticated user",
+ "description": "Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/user/codespaces/secrets/{secret_name}/repositories": {
+ "get": {
+ "summary": "List selected repositories for a user secret",
+ "description": "List the repositories that have been granted the ability to use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/list-repositories-for-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-paginated"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ },
+ "put": {
+ "summary": "Set selected repositories for a user secret",
+ "description": "Select the repositories that will use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/set-repositories-for-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "selected_repository_ids": {
+ "type": "array",
+ "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "selected_repository_ids"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "selected_repository_ids": [
+ "1296269",
+ "1296280"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "No Content when repositories were added to the selected list"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add a selected repository to a user secret",
+ "description": "Adds a repository to the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/add-repository-for-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when repository was added to the selected list"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ },
+ "delete": {
+ "summary": "Remove a selected repository from a user secret",
+ "description": "Removes a repository from the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/remove-repository-for-secret-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/secret-name"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content when repository was removed from the selected list"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "secrets"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}": {
+ "get": {
+ "summary": "Get a codespace for the authenticated user",
+ "description": "Gets information about a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ },
+ "patch": {
+ "summary": "Update a codespace for the authenticated user",
+ "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/update-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "machine": {
+ "description": "A valid machine to transition this codespace to.",
+ "type": "string"
+ },
+ "display_name": {
+ "description": "Display name for this codespace",
+ "type": "string"
+ },
+ "recent_folders": {
+ "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "machine": "standardLinux"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ },
+ "delete": {
+ "summary": "Delete a codespace for the authenticated user",
+ "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/delete-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "202": {
+ "$ref": "#/components/responses/accepted"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/exports": {
+ "post": {
+ "summary": "Export a codespace for the authenticated user",
+ "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/export-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace-export-details"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-export-details"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/exports/{export_id}": {
+ "get": {
+ "summary": "Get details about a codespace export",
+ "description": "Gets information about an export of a codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/get-export-details-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ },
+ {
+ "$ref": "#/components/parameters/export-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace-export-details"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-export-details"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/machines": {
+ "get": {
+ "summary": "List machine types for a codespace",
+ "description": "List the machine types a codespace can transition to use.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/codespace-machines-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "machines"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "machines": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/codespace-machine"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace-machines-list"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "machines"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/publish": {
+ "post": {
+ "summary": "Create a repository from an unpublished codespace",
+ "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/publish-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A name for the new repository.",
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the new repository should be private.",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repository": "monalisa-octocat-hello-world-g4wpq6h95q",
+ "private": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace-with-full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace-with-full-repository"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/start": {
+ "post": {
+ "summary": "Start a codespace for the authenticated user",
+ "description": "Starts a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/start-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "402": {
+ "description": "Payment required",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/codespaces/{codespace_name}/stop": {
+ "post": {
+ "summary": "Stop a codespace for the authenticated user",
+ "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.",
+ "tags": [
+ "codespaces"
+ ],
+ "operationId": "codespaces/stop-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/codespace-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/codespace"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/codespace"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/internal_error"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "codespaces",
+ "subcategory": "codespaces"
+ }
+ }
+ },
+ "/user/docker/conflicts": {
+ "get": {
+ "summary": "Get list of conflicting packages during Docker migration for authenticated-user",
+ "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user"
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-user"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/email/visibility": {
+ "patch": {
+ "summary": "Set primary email visibility for the authenticated user",
+ "description": "Sets the visibility for your primary email addresses.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/set-primary-email-visibility-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "visibility": {
+ "description": "Denotes whether an email is publicly visible.",
+ "type": "string",
+ "enum": [
+ "public",
+ "private"
+ ]
+ }
+ },
+ "required": [
+ "visibility"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Example setting the primary email address to private",
+ "value": {
+ "visibility": "private"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/email"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/email-items-3"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "emails"
+ }
+ }
+ },
+ "/user/emails": {
+ "get": {
+ "summary": "List email addresses for the authenticated user",
+ "description": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-emails-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/email"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/email-items-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "emails"
+ }
+ },
+ "post": {
+ "summary": "Add an email address for the authenticated user",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/add-email-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "emails": {
+ "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ },
+ "example": [
+
+ ]
+ }
+ },
+ "required": [
+ "emails"
+ ],
+ "example": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example adding multiple email addresses",
+ "value": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com",
+ "octocat@octocat.org"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/email"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/email-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "emails"
+ }
+ },
+ "delete": {
+ "summary": "Delete an email address for the authenticated user",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-email-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
+ "properties": {
+ "emails": {
+ "description": "Email addresses associated with the GitHub user account.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ }
+ }
+ },
+ "example": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com"
+ ]
+ },
+ "required": [
+ "emails"
+ ]
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "summary": "Example deleting multiple email accounts",
+ "value": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "emails"
+ }
+ }
+ },
+ "/user/followers": {
+ "get": {
+ "summary": "List followers of the authenticated user",
+ "description": "Lists the people following the authenticated user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/user/following": {
+ "get": {
+ "summary": "List the people the authenticated user follows",
+ "description": "Lists the people who the authenticated user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followed-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/user/following/{username}": {
+ "get": {
+ "summary": "Check if a person is followed by the authenticated user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-person-is-followed-by-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "if the person is followed by the authenticated user"
+ },
+ "404": {
+ "description": "if the person is not followed by the authenticated user",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ },
+ "put": {
+ "summary": "Follow a user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/follow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#follow-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ },
+ "delete": {
+ "summary": "Unfollow a user",
+ "description": "OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/unfollow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#unfollow-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/user/gpg_keys": {
+ "get": {
+ "summary": "List GPG keys for the authenticated user",
+ "description": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gpg-key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gpg-key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "gpg-keys"
+ }
+ },
+ "post": {
+ "summary": "Create a GPG key for the authenticated user",
+ "description": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "A descriptive name for the new key.",
+ "type": "string"
+ },
+ "armored_public_key": {
+ "description": "A GPG key in ASCII-armored format.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "required": [
+ "armored_public_key"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Octocat's GPG Key",
+ "armored_public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1\n\nmQINBFnZ2ZIBEADQ2Z7Z7\n-----END PGP PUBLIC KEY BLOCK-----"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gpg-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gpg-key"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "gpg-keys"
+ }
+ }
+ },
+ "/user/gpg_keys/{gpg_key_id}": {
+ "get": {
+ "summary": "Get a GPG key for the authenticated user",
+ "description": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-gpg-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gpg-key-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/gpg-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gpg-key"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "gpg-keys"
+ }
+ },
+ "delete": {
+ "summary": "Delete a GPG key for the authenticated user",
+ "description": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/gpg-key-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "gpg-keys"
+ }
+ }
+ },
+ "/user/installations": {
+ "get": {
+ "summary": "List app installations accessible to the user access token",
+ "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "You can find the permissions for the installation under the `permissions` key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "installations"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "installations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/installation"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-installation-for-auth-user-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/user/installations/{installation_id}/repositories": {
+ "get": {
+ "summary": "List repositories accessible to the user access token",
+ "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installation-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The access the user has to each repository is included in the hash under the `permissions` key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "repositories"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repository_selection": {
+ "type": "string"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-paginated"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/user/installations/{installation_id}/repositories/{repository_id}": {
+ "put": {
+ "summary": "Add a repository to an app installation",
+ "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ },
+ {
+ "$ref": "#/components/parameters/repository-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ },
+ "delete": {
+ "summary": "Remove a repository from an app installation",
+ "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/installation-id"
+ },
+ {
+ "$ref": "#/components/parameters/repository-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization."
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/user/interaction-limits": {
+ "get": {
+ "summary": "Get interaction restrictions for your public repositories",
+ "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/get-restrictions-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories"
+ },
+ "responses": {
+ "200": {
+ "description": "Default response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-response"
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when there are no restrictions"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "interactions",
+ "subcategory": "user"
+ }
+ },
+ "put": {
+ "summary": "Set interaction restrictions for your public repositories",
+ "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/set-restrictions-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories"
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "limit": "collaborators_only",
+ "expiry": "one_month"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/interaction-limit-response"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/interaction-limit-user"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "interactions",
+ "subcategory": "user"
+ }
+ },
+ "delete": {
+ "summary": "Remove interaction restrictions from your public repositories",
+ "description": "Removes any interaction restrictions from your public repositories.",
+ "tags": [
+ "interactions"
+ ],
+ "operationId": "interactions/remove-restrictions-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories"
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "interactions",
+ "subcategory": "user"
+ }
+ }
+ },
+ "/user/issues": {
+ "get": {
+ "summary": "List user account issues assigned to the authenticated user",
+ "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "assigned",
+ "created",
+ "mentioned",
+ "subscribed",
+ "repos",
+ "all"
+ ],
+ "default": "assigned"
+ }
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/labels"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/issue"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/issue-with-repo-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "issues",
+ "subcategory": "issues"
+ }
+ }
+ },
+ "/user/keys": {
+ "get": {
+ "summary": "List public SSH keys for the authenticated user",
+ "description": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "keys"
+ }
+ },
+ "post": {
+ "summary": "Create a public SSH key for the authenticated user",
+ "description": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "A descriptive name for the new key.",
+ "type": "string",
+ "example": "Personal MacBook Air"
+ },
+ "key": {
+ "description": "The public SSH key to add to your GitHub account.",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/key"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "keys"
+ }
+ }
+ },
+ "/user/keys/{key_id}": {
+ "get": {
+ "summary": "Get a public SSH key for the authenticated user",
+ "description": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/key-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/key"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "keys"
+ }
+ },
+ "delete": {
+ "summary": "Delete a public SSH key for the authenticated user",
+ "description": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/key-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "keys"
+ }
+ }
+ },
+ "/user/marketplace_purchases": {
+ "get": {
+ "summary": "List subscriptions for the authenticated user",
+ "description": "Lists the active subscriptions for the authenticated user.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-subscriptions-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/user-marketplace-purchase"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-marketplace-purchase-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/user/marketplace_purchases/stubbed": {
+ "get": {
+ "summary": "List subscriptions for the authenticated user (stubbed)",
+ "description": "Lists the active subscriptions for the authenticated user.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-subscriptions-for-authenticated-user-stubbed",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/user-marketplace-purchase"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-marketplace-purchase-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "marketplace"
+ }
+ }
+ },
+ "/user/memberships/orgs": {
+ "get": {
+ "summary": "List organization memberships for the authenticated user",
+ "description": "Lists all of the authenticated user's organization memberships.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-memberships-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "state",
+ "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/org-membership"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-membership-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/user/memberships/orgs/{org}": {
+ "get": {
+ "summary": "Get an organization membership for the authenticated user",
+ "description": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-membership"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-membership"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ },
+ "patch": {
+ "summary": "Update an organization membership for the authenticated user",
+ "description": "Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state that the membership should be in. Only `\"active\"` will be accepted.",
+ "enum": [
+ "active"
+ ]
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/org-membership"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/org-membership-2"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/user/migrations": {
+ "get": {
+ "summary": "List user migrations",
+ "description": "Lists all migrations a user has started.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#list-user-migrations"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/migration"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ },
+ "post": {
+ "summary": "Start a user migration",
+ "description": "Initiates the generation of a user migration archive.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/start-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#start-a-user-migration"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "lock_repositories": {
+ "description": "Lock the repositories being migrated at the start of the migration",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "exclude_metadata": {
+ "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "exclude_git_data": {
+ "description": "Indicates whether the repository git data should be excluded from the migration.",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "exclude_attachments": {
+ "description": "Do not include attachments in the migration",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "exclude_releases": {
+ "description": "Do not include releases in the migration",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "exclude_owner_projects": {
+ "description": "Indicates whether projects owned by the organization or users should be excluded.",
+ "example": true,
+ "readOnly": false,
+ "type": "boolean"
+ },
+ "org_metadata_only": {
+ "type": "boolean",
+ "example": true,
+ "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).",
+ "default": false
+ },
+ "exclude": {
+ "description": "Exclude attributes from the API response to improve performance",
+ "example": [
+ "repositories"
+ ],
+ "readOnly": false,
+ "type": "array",
+ "items": {
+ "description": "Allowed values that can be passed to the exclude param.",
+ "enum": [
+ "repositories"
+ ],
+ "example": "repositories",
+ "type": "string"
+ }
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "description": "Repository path, owner and name",
+ "example": "acme/widgets",
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "repositories"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "octocat/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/migration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration-2"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/migrations/{migration_id}": {
+ "get": {
+ "summary": "Get a user migration status",
+ "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-status-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#get-a-user-migration-status"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "name": "exclude",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/migration"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/migration"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/migrations/{migration_id}/archive": {
+ "get": {
+ "summary": "Download a user migration archive",
+ "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/get-archive-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#download-a-user-migration-archive"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/migration-id"
+ }
+ ],
+ "responses": {
+ "302": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Delete a user migration archive",
+ "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/delete-archive-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/migration-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/migrations/{migration_id}/repos/{repo_name}/lock": {
+ "delete": {
+ "summary": "Unlock a user repository",
+ "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/unlock-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#unlock-a-user-repository"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "$ref": "#/components/parameters/repo-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/migrations/{migration_id}/repositories": {
+ "get": {
+ "summary": "List repositories for a user migration",
+ "description": "Lists all the repositories for this user migration.",
+ "tags": [
+ "migrations"
+ ],
+ "operationId": "migrations/list-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/migration-id"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "migrations",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/user/orgs": {
+ "get": {
+ "summary": "List organizations for the authenticated user",
+ "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/user/packages": {
+ "get": {
+ "summary": "List packages for the authenticated user's namespace",
+ "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-packages-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace"
+ },
+ "parameters": [
+ {
+ "name": "package_type",
+ "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/package-visibility"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-user"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/package_es_list_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/packages/{package_type}/{package_name}": {
+ "get": {
+ "summary": "Get a package for the authenticated user",
+ "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-user"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a package for the authenticated user",
+ "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/packages/{package_type}/{package_name}/restore": {
+ "post": {
+ "summary": "Restore a package for the authenticated user",
+ "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "name": "token",
+ "description": "package token",
+ "schema": {
+ "type": "string"
+ },
+ "required": false,
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/packages/{package_type}/{package_name}/versions": {
+ "get": {
+ "summary": "List package versions for a package owned by the authenticated user",
+ "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "required": false,
+ "description": "The state of the package, either active or deleted.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "active",
+ "deleted"
+ ],
+ "default": "active"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package-version"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-versions-for-authenticated-user"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": {
+ "get": {
+ "summary": "Get a package version for the authenticated user",
+ "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-version-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package-version"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-version-authenticated-user"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a package version for the authenticated user",
+ "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-version-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
+ "post": {
+ "summary": "Restore a package version for the authenticated user",
+ "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-version-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/user/projects": {
+ "post": {
+ "summary": "Create a user project",
+ "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#create-a-user-project"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Name of the project",
+ "example": "Week One Sprint",
+ "type": "string"
+ },
+ "body": {
+ "description": "Body of the project",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Create a new project",
+ "value": {
+ "name": "My Projects",
+ "body": "A board to manage my personal projects."
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/project"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project"
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed_simple"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ }
+ },
+ "/user/public_emails": {
+ "get": {
+ "summary": "List public email addresses for the authenticated user",
+ "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-emails-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/email"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/email-items-2"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "emails"
+ }
+ }
+ },
+ "/user/repos": {
+ "get": {
+ "summary": "List repositories for the authenticated user",
+ "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "visibility",
+ "description": "Limit results to repositories with the specified visibility.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "public",
+ "private"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "affiliation",
+ "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "owner,collaborator,organization_member"
+ }
+ },
+ {
+ "name": "type",
+ "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "public",
+ "private",
+ "member"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/since-repo-date"
+ },
+ {
+ "$ref": "#/components/parameters/before-repo-date"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-items-default-response"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ },
+ "post": {
+ "summary": "Create a repository for the authenticated user",
+ "description": "Creates a new repository for the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "description": {
+ "description": "A short description of the repository.",
+ "type": "string"
+ },
+ "homepage": {
+ "description": "A URL with more information about the repository.",
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private.",
+ "default": false,
+ "type": "boolean"
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "team_id": {
+ "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "type": "integer"
+ },
+ "auto_init": {
+ "description": "Whether the repository is initialized with a minimal README.",
+ "default": false,
+ "type": "boolean"
+ },
+ "gitignore_template": {
+ "description": "The desired language or platform to apply to the .gitignore.",
+ "example": "Haskell",
+ "type": "string"
+ },
+ "license_template": {
+ "description": "The license keyword of the open source license for this repository.",
+ "example": "mit",
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repo!",
+ "homepage": "https://github.com",
+ "private": false,
+ "is_template": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/full-repository"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "400": {
+ "$ref": "#/components/responses/bad_request"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/user/repository_invitations": {
+ "get": {
+ "summary": "List repository invitations for the authenticated user",
+ "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-invitation"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/repository-invitation-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ }
+ },
+ "/user/repository_invitations/{invitation_id}": {
+ "patch": {
+ "summary": "Accept a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/accept-invitation-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ },
+ "delete": {
+ "summary": "Decline a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/decline-invitation-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/invitation-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "409": {
+ "$ref": "#/components/responses/conflict"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "collaborators",
+ "subcategory": "invitations"
+ }
+ }
+ },
+ "/user/social_accounts": {
+ "get": {
+ "summary": "List social accounts for the authenticated user",
+ "description": "Lists all of your social accounts.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-social-accounts-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/social-account"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/social-account-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "social-accounts"
+ }
+ },
+ "post": {
+ "summary": "Add social accounts for the authenticated user",
+ "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/add-social-account-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "account_urls": {
+ "description": "Full URLs for the social media profiles to add.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "https://twitter.com/github"
+ },
+ "example": [
+
+ ]
+ }
+ },
+ "required": [
+ "account_urls"
+ ],
+ "example": {
+ "account_urls": [
+ "https://www.linkedin.com/company/github/",
+ "https://twitter.com/github"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Adding multiple social accounts",
+ "value": {
+ "account_urls": [
+ "https://facebook.com/GitHub",
+ "https://www.youtube.com/@GitHub"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/social-account"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/social-account-items"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "social-accounts"
+ }
+ },
+ "delete": {
+ "summary": "Delete social accounts for the authenticated user",
+ "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-social-account-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "account_urls": {
+ "description": "Full URLs for the social media profiles to delete.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "https://twitter.com/github"
+ },
+ "example": [
+
+ ]
+ }
+ },
+ "required": [
+ "account_urls"
+ ],
+ "example": {
+ "account_urls": [
+ "https://www.linkedin.com/company/github/",
+ "https://twitter.com/github"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Deleting multiple social accounts",
+ "value": {
+ "account_urls": [
+ "https://facebook.com/GitHub",
+ "https://www.youtube.com/@GitHub"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "social-accounts"
+ }
+ }
+ },
+ "/user/ssh_signing_keys": {
+ "get": {
+ "summary": "List SSH signing keys for the authenticated user",
+ "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-ssh-signing-keys-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ssh-signing-key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ssh-signing-key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": "ssh-signing-keys"
+ }
+ },
+ "post": {
+ "summary": "Create a SSH signing key for the authenticated user",
+ "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.",
+ "operationId": "users/create-ssh-signing-key-for-authenticated-user",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "A descriptive name for the new key.",
+ "type": "string",
+ "example": "Personal MacBook Air"
+ },
+ "key": {
+ "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com "
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ssh-signing-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ssh-signing-key"
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "ssh-signing-keys"
+ }
+ }
+ },
+ "/user/ssh_signing_keys/{ssh_signing_key_id}": {
+ "get": {
+ "summary": "Get an SSH signing key for the authenticated user",
+ "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-ssh-signing-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ssh-signing-key-id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ssh-signing-key"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ssh-signing-key"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "ssh-signing-keys"
+ }
+ },
+ "delete": {
+ "summary": "Delete an SSH signing key for the authenticated user",
+ "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-ssh-signing-key-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/ssh-signing-key-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "ssh-signing-keys"
+ }
+ }
+ },
+ "/user/starred": {
+ "get": {
+ "summary": "List repositories starred by the authenticated user",
+ "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sort-starred"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/repository-items-default-response"
+ }
+ }
+ },
+ "application/vnd.github.v3.star+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/starred-repository"
+ }
+ },
+ "examples": {
+ "alternative-response-with-star-creation-timestamps": {
+ "$ref": "#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ }
+ },
+ "/user/starred/{owner}/{repo}": {
+ "get": {
+ "summary": "Check if a repository is starred by the authenticated user",
+ "description": "Whether the authenticated user has starred the repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/check-repo-is-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if this repository is starred by you"
+ },
+ "404": {
+ "description": "Not Found if this repository is not starred by you",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ },
+ "put": {
+ "summary": "Star a repository for the authenticated user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/star-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ },
+ "delete": {
+ "summary": "Unstar a repository for the authenticated user",
+ "description": "Unstar a repository that the authenticated user has previously starred.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/unstar-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/owner"
+ },
+ {
+ "$ref": "#/components/parameters/repo"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ }
+ },
+ "/user/subscriptions": {
+ "get": {
+ "summary": "List repositories watched by the authenticated user",
+ "description": "Lists repositories the authenticated user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watched-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ }
+ },
+ "/user/teams": {
+ "get": {
+ "summary": "List teams for the authenticated user",
+ "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-full"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/team-full-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "teams"
+ }
+ }
+ },
+ "/users": {
+ "get": {
+ "summary": "List users",
+ "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/users#list-users"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/since-user"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/not_modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/users/{username}": {
+ "get": {
+ "summary": "Get a user",
+ "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/users/emails)\".",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-by-username",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/users#get-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/private-user"
+ },
+ {
+ "$ref": "#/components/schemas/public-user"
+ }
+ ]
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/public-user-default-response"
+ },
+ "response-with-git-hub-plan-information": {
+ "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/users/{username}/docker/conflicts": {
+ "get": {
+ "summary": "Get list of conflicting packages during Docker migration for user",
+ "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-docker-migration-conflicting-packages-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-user"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/events": {
+ "get": {
+ "summary": "List events for the authenticated user",
+ "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/users/{username}/events/orgs/{org}": {
+ "get": {
+ "summary": "List organization events for the authenticated user",
+ "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-org-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-org-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/users/{username}/events/public": {
+ "get": {
+ "summary": "List public events for a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-public-events-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-public-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/users/{username}/followers": {
+ "get": {
+ "summary": "List followers of a user",
+ "description": "Lists the people following the specified user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#list-followers-of-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/users/{username}/following": {
+ "get": {
+ "summary": "List the people a user follows",
+ "description": "Lists the people who the specified user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#list-the-people-a-user-follows"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/simple-user-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/users/{username}/following/{target_user}": {
+ "get": {
+ "summary": "Check if a user follows another user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "name": "target_user",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "if the user follows the target user"
+ },
+ "404": {
+ "description": "if the user does not follow the target user"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "followers"
+ }
+ }
+ },
+ "/users/{username}/gists": {
+ "get": {
+ "summary": "List gists for a user",
+ "description": "Lists public gists for the specified user:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/gists/gists#list-gists-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/since"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/base-gist"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/base-gist-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "gists",
+ "subcategory": "gists"
+ }
+ }
+ },
+ "/users/{username}/gpg_keys": {
+ "get": {
+ "summary": "List GPG keys for a user",
+ "description": "Lists the GPG keys for a user. This information is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gpg-key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/gpg-key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "gpg-keys"
+ }
+ }
+ },
+ "/users/{username}/hovercard": {
+ "get": {
+ "summary": "Get contextual information for a user",
+ "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-context-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/users#get-contextual-information-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "name": "subject_type",
+ "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "organization",
+ "repository",
+ "issue",
+ "pull_request"
+ ]
+ }
+ },
+ {
+ "name": "subject_id",
+ "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/hovercard"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/hovercard"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "users",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/users/{username}/installation": {
+ "get": {
+ "summary": "Get a user installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-user-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/installation"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "apps",
+ "subcategory": "apps"
+ }
+ }
+ },
+ "/users/{username}/keys": {
+ "get": {
+ "summary": "List public keys for a user",
+ "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/keys#list-public-keys-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/key-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/key-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "keys"
+ }
+ }
+ },
+ "/users/{username}/orgs": {
+ "get": {
+ "summary": "List organizations for a user",
+ "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/organization-simple"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/organization-simple-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "orgs",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/users/{username}/packages": {
+ "get": {
+ "summary": "List packages for a user",
+ "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/list-packages-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-packages-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "package_type",
+ "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/package-visibility"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-for-user"
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ },
+ "400": {
+ "$ref": "#/components/responses/package_es_list_error"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/packages/{package_type}/{package_name}": {
+ "get": {
+ "summary": "Get a package for a user",
+ "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-user"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a package for a user",
+ "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/packages/{package_type}/{package_name}/restore": {
+ "post": {
+ "summary": "Restore a package for a user",
+ "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "name": "token",
+ "description": "package token",
+ "schema": {
+ "type": "string"
+ },
+ "required": false,
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/packages/{package_type}/{package_name}/versions": {
+ "get": {
+ "summary": "List package versions for a package owned by a user",
+ "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/package-version"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-versions-for-user"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": {
+ "get": {
+ "summary": "Get a package version for a user",
+ "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/get-package-version-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/package-version"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/package-version-user"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ },
+ "delete": {
+ "summary": "Delete package version for a user",
+ "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/delete-package-version-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
+ "post": {
+ "summary": "Restore package version for a user",
+ "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "tags": [
+ "packages"
+ ],
+ "operationId": "packages/restore-package-version-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/package-type"
+ },
+ {
+ "$ref": "#/components/parameters/package-name"
+ },
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/package-version-id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "403": {
+ "$ref": "#/components/responses/forbidden"
+ },
+ "401": {
+ "$ref": "#/components/responses/requires_authentication"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "packages",
+ "subcategory": "packages"
+ }
+ }
+ },
+ "/users/{username}/projects": {
+ "get": {
+ "summary": "List user projects",
+ "description": "Lists projects for a user.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/projects/projects#list-user-projects"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the projects to return.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/project-items-3"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "422": {
+ "$ref": "#/components/responses/validation_failed"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "projects",
+ "subcategory": "projects"
+ }
+ }
+ },
+ "/users/{username}/received_events": {
+ "get": {
+ "summary": "List events received by the authenticated user",
+ "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-received-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/users/{username}/received_events/public": {
+ "get": {
+ "summary": "List public events received by a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/event"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/user-received-public-events-items"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/users/{username}/repos": {
+ "get": {
+ "summary": "List repositories for a user",
+ "description": "Lists public repositories for the specified user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/repos/repos#list-repositories-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "name": "type",
+ "description": "Limit results to repositories of the specified type.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "member"
+ ],
+ "default": "owner"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "repos"
+ }
+ }
+ },
+ "/users/{username}/settings/billing/actions": {
+ "get": {
+ "summary": "Get GitHub Actions billing for a user",
+ "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "operationId": "billing/get-github-actions-billing-user",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/actions-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/actions-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/users/{username}/settings/billing/packages": {
+ "get": {
+ "summary": "Get GitHub Packages billing for a user",
+ "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "operationId": "billing/get-github-packages-billing-user",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/packages-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/packages-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/users/{username}/settings/billing/shared-storage": {
+ "get": {
+ "summary": "Get shared storage billing for a user",
+ "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.",
+ "operationId": "billing/get-shared-storage-billing-user",
+ "tags": [
+ "billing"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/combined-billing-usage"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/combined-billing-usage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "billing",
+ "subcategory": "billing"
+ }
+ }
+ },
+ "/users/{username}/social_accounts": {
+ "get": {
+ "summary": "List social accounts for a user",
+ "description": "Lists social media accounts for a user. This endpoint is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-social-accounts-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/social-account"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/social-account-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "social-accounts"
+ }
+ }
+ },
+ "/users/{username}/ssh_signing_keys": {
+ "get": {
+ "summary": "List SSH signing keys for a user",
+ "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-ssh-signing-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ssh-signing-key"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ssh-signing-key-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "users",
+ "subcategory": "ssh-signing-keys"
+ }
+ }
+ },
+ "/users/{username}/starred": {
+ "get": {
+ "summary": "List repositories starred by a user",
+ "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/sort-starred"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/starred-repository"
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default-response": {
+ "$ref": "#/components/examples/repository-items-default-response"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "starring"
+ }
+ }
+ },
+ "/users/{username}/subscriptions": {
+ "get": {
+ "summary": "List repositories watched by a user",
+ "description": "Lists repositories a user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-watched-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/username"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/minimal-repository-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ }
+ },
+ "/versions": {
+ "get": {
+ "summary": "Get all API versions",
+ "description": "Get all supported GitHub API versions.",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-all-versions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/meta/meta#get-all-api-versions"
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "date",
+ "example": "2021-01-01"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ "2021-01-01",
+ "2021-06-01",
+ "2022-01-01"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "meta",
+ "subcategory": "meta"
+ }
+ }
+ },
+ "/zen": {
+ "get": {
+ "summary": "Get the Zen of GitHub",
+ "description": "Get a random sentence from the Zen of GitHub",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-zen",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/meta/meta#get-the-zen-of-github"
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "summary": "Example response",
+ "value": "Responsive is better than fast"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "meta",
+ "subcategory": "meta"
+ }
+ }
+ }
+ },
+ "x-webhooks": {
+ "branch-protection-configuration-disabled": {
+ "post": {
+ "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "description": "All branch protections were disabled for a repository.",
+ "operationId": "branch-protection-configuration/disabled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-branch-protection-configuration-disabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "branch_protection_configuration",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "branch-protection-configuration-enabled": {
+ "post": {
+ "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "description": "All branch protections were enabled for a repository.",
+ "operationId": "branch-protection-configuration/enabled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-branch-protection-configuration-enabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "branch_protection_configuration",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "branch-protection-rule-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "description": "A branch protection rule was created.",
+ "operationId": "branch-protection-rule/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-branch-protection-rule-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "branch_protection_rule",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "branch-protection-rule-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "description": "A branch protection rule was deleted.",
+ "operationId": "branch-protection-rule/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "branch_protection_rule",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "branch-protection-rule-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "description": "A branch protection rule was edited.",
+ "operationId": "branch-protection-rule/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-branch-protection-rule-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "branch_protection_rule",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-run-completed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "A check run was completed, and a conclusion is available.",
+ "operationId": "check-run/completed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-completed"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-completed"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-completed-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "check_run",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-run-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "A new check run was created.",
+ "operationId": "check-run/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-created"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-created"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-created-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-created-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "check_run",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-run-requested-action": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"",
+ "operationId": "check-run/requested-action",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-requested-action"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-requested-action"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-requested-action-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "check_run",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-run-rerequested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.",
+ "operationId": "check-run/rerequested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-rerequested"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-rerequested"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/check-run-rerequested-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "check_run",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-suite-completed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "All check runs in a check suite have completed, and a conclusion is available.",
+ "operationId": "check-suite/completed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-suite-completed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "check_suite",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-suite-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)\" in the REST API documentation.",
+ "operationId": "check-suite/requested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-suite-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "check_suite",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "check-suite-rerequested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
+ "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.",
+ "operationId": "check-suite/rerequested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-check-suite-rerequested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "check_suite",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-appeared-in-branch": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.",
+ "operationId": "code-scanning-alert/appeared-in-branch",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-closed-by-user": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "Someone closed a code scanning alert.",
+ "operationId": "code-scanning-alert/closed-by-user",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "A code scanning alert was created in a repository.",
+ "operationId": "code-scanning-alert/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-fixed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "A code scanning alert was fixed in a branch by a commit.",
+ "operationId": "code-scanning-alert/fixed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "A previously fixed code scanning alert reappeared in a branch.",
+ "operationId": "code-scanning-alert/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "code-scanning-alert-reopened-by-user": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.",
+ "description": "Someone reopened a code scanning alert.",
+ "operationId": "code-scanning-alert/reopened-by-user",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "code_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "commit-comment-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "Someone commented on a commit.",
+ "operationId": "commit-comment/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-commit-comment-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "commit_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "create": {
+ "post": {
+ "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.",
+ "operationId": "create",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#create"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-create"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "create",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "custom-property-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.",
+ "description": "A new custom property was created.",
+ "operationId": "custom-property/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-custom-property-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "custom_property",
+ "supported-webhook-types": [
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "custom-property-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.",
+ "description": "A custom property was deleted.",
+ "operationId": "custom-property/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-custom-property-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "custom_property",
+ "supported-webhook-types": [
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "custom-property-updated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.",
+ "description": "A custom property was updated.",
+ "operationId": "custom-property/updated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-custom-property-updated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "custom_property",
+ "supported-webhook-types": [
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "custom-property-values-updated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.",
+ "description": "The custom property values of a repository were updated.",
+ "operationId": "custom-property-values/updated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-custom-property-values-updated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "custom-property-values",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "delete": {
+ "post": {
+ "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.",
+ "operationId": "delete",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#delete"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-delete"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "delete",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-auto-dismissed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.",
+ "operationId": "dependabot-alert/auto-dismissed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-auto-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.",
+ "operationId": "dependabot-alert/auto-reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.",
+ "operationId": "dependabot-alert/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-dismissed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A Dependabot alert was manually closed.",
+ "operationId": "dependabot-alert/dismissed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-fixed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A manifest file change removed a vulnerability.",
+ "operationId": "dependabot-alert/fixed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-reintroduced": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
+ "operationId": "dependabot-alert/reintroduced",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "dependabot-alert-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
+ "description": "A Dependabot alert was manually reopened.",
+ "operationId": "dependabot-alert/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "dependabot_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "deploy-key-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deploy key was created.",
+ "operationId": "deploy-key/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deploy-key-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deploy_key",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "deploy-key-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deploy key was deleted.",
+ "operationId": "deploy-key/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deploy-key-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deploy_key",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deployment was created.",
+ "operationId": "deployment/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-protection-rule-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deployment protection rule was requested for an environment.",
+ "operationId": "deployment-protection-rule/requested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment_protection_rule",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-review-approved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deployment review was approved.",
+ "operationId": "deployment-review/approved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-review-approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment_review",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-review-rejected": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deployment review was rejected.",
+ "operationId": "deployment-review/rejected",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-review-rejected"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment_review",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-review-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A deployment review was requested.",
+ "operationId": "deployment-review/requested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-review-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment_review",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "deployment-status-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
+ "description": "A new deployment status was created.",
+ "operationId": "deployment-status/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_status"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-deployment-status-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "deployment_status",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-answered": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A comment on the discussion was marked as the answer.",
+ "operationId": "discussion/answered",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-answered"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-category-changed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "The category of a discussion was changed.",
+ "operationId": "discussion/category-changed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-category-changed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was closed.",
+ "operationId": "discussion/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "discussions",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-comment-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A comment on a discussion was created.",
+ "operationId": "discussion-comment/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-comment-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-comment-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A comment on a discussion was deleted.",
+ "operationId": "discussion-comment/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-comment-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-comment-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A comment on a discussion was edited.",
+ "operationId": "discussion-comment/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-comment-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was created.",
+ "operationId": "discussion/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was deleted.",
+ "operationId": "discussion/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "The title or body on a discussion was edited, or the category of the discussion was changed.",
+ "operationId": "discussion/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-labeled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A label was added to a discussion.",
+ "operationId": "discussion/labeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-labeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-locked": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was locked.",
+ "operationId": "discussion/locked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-locked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-pinned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was pinned.",
+ "operationId": "discussion/pinned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-pinned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was reopened.",
+ "operationId": "discussion/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "discussions",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-transferred": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was transferred to another repository.",
+ "operationId": "discussion/transferred",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-transferred"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-unanswered": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A comment on the discussion was unmarked as the answer.",
+ "operationId": "discussion/unanswered",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-unanswered"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-unlabeled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A label was removed from a discussion.",
+ "operationId": "discussion/unlabeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-unlabeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-unlocked": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was unlocked.",
+ "operationId": "discussion/unlocked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-unlocked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "discussion-unpinned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.",
+ "description": "A discussion was unpinned.",
+ "operationId": "discussion/unpinned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-discussion-unpinned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "discussion",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "fork": {
+ "post": {
+ "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "operationId": "fork",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#fork"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-fork"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "fork",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "github-app-authorization-revoked": {
+ "post": {
+ "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"",
+ "description": "Someone revoked their authorization of a GitHub App.",
+ "operationId": "github-app-authorization/revoked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#github_app_authorization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-github-app-authorization-revoked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "github_app_authorization",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "gollum": {
+ "post": {
+ "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "operationId": "gollum",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#gollum"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-gollum"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "gollum",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Someone installed a GitHub App on a user or organization account.",
+ "operationId": "installation/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Someone uninstalled a GitHub App from their user or organization account.",
+ "operationId": "installation/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-new-permissions-accepted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Someone granted new permissions to a GitHub App.",
+ "operationId": "installation/new-permissions-accepted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-repositories-added": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "A GitHub App installation was granted access to one or more repositories.",
+ "operationId": "installation-repositories/added",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-repositories-added"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation_repositories",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-repositories-removed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Access to one or more repositories was revoked for a GitHub App installation.",
+ "operationId": "installation-repositories/removed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-repositories-removed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation_repositories",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-suspend": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Someone blocked access by a GitHub App to their user or organization account.",
+ "operationId": "installation/suspend",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-suspend"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-target-renamed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "Somebody renamed the user or organization account that a GitHub App is installed on.",
+ "operationId": "installation-target/renamed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_target"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-target-renamed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation_target",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "installation-unsuspend": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.",
+ "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.",
+ "operationId": "installation/unsuspend",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-installation-unsuspend"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "installation",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "issue-comment-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A comment on an issue or pull request was created.",
+ "operationId": "issue-comment/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issue-comment-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issue_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issue-comment-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A comment on an issue or pull request was deleted.",
+ "operationId": "issue-comment/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issue-comment-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issue_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issue-comment-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A comment on an issue or pull request was edited.",
+ "operationId": "issue-comment/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issue-comment-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issue_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-assigned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was assigned to a user.",
+ "operationId": "issues/assigned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-assigned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was closed.",
+ "operationId": "issues/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was deleted.",
+ "operationId": "issues/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-demilestoned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was removed from a milestone.",
+ "operationId": "issues/demilestoned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-demilestoned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "The title or body on an issue was edited.",
+ "operationId": "issues/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-labeled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A label was added to an issue.",
+ "operationId": "issues/labeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-labeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-locked": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"",
+ "operationId": "issues/locked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-locked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-milestoned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was added to a milestone.",
+ "operationId": "issues/milestoned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-milestoned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-opened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.",
+ "operationId": "issues/opened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-opened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-pinned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"",
+ "operationId": "issues/pinned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-pinned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A closed issue was reopened.",
+ "operationId": "issues/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-transferred": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"",
+ "operationId": "issues/transferred",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-transferred"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-unassigned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A user was unassigned from an issue.",
+ "operationId": "issues/unassigned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-unassigned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-unlabeled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "A label was removed from an issue.",
+ "operationId": "issues/unlabeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-unlabeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-unlocked": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"",
+ "operationId": "issues/unlocked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-unlocked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "issues-unpinned": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.",
+ "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"",
+ "operationId": "issues/unpinned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-issues-unpinned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "issues",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "label-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A label was created.",
+ "operationId": "label/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-label-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "label",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "label-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A label was deleted.",
+ "operationId": "label/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-label-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "label",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "label-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A label's name, description, or color was changed.",
+ "operationId": "label/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-label-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "label",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "marketplace-purchase-cancelled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.",
+ "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.",
+ "operationId": "marketplace-purchase/cancelled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "marketplace_purchase",
+ "supported-webhook-types": [
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "marketplace-purchase-changed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.",
+ "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.",
+ "operationId": "marketplace-purchase/changed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-marketplace-purchase-changed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "marketplace_purchase",
+ "supported-webhook-types": [
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "marketplace-purchase-pending-change": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.",
+ "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.",
+ "operationId": "marketplace-purchase/pending-change",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "marketplace_purchase",
+ "supported-webhook-types": [
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "marketplace-purchase-pending-change-cancelled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.",
+ "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.",
+ "operationId": "marketplace-purchase/pending-change-cancelled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "marketplace_purchase",
+ "supported-webhook-types": [
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "marketplace-purchase-purchased": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.",
+ "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.",
+ "operationId": "marketplace-purchase/purchased",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "marketplace_purchase",
+ "supported-webhook-types": [
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "member-added": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A GitHub user accepted an invitation to a repository.",
+ "operationId": "member/added",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-member-added"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "member",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "member-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "Permissions were changed for a collaborator on a repository.",
+ "operationId": "member/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-member-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "member",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "member-removed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A collaborator was removed from a repository.",
+ "operationId": "member/removed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-member-removed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "member",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "membership-added": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "An organization member was added to a team.",
+ "operationId": "membership/added",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-membership-added"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "membership",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "membership-removed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "An organization member was removed from a team.",
+ "operationId": "membership/removed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-membership-removed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "membership",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "merge-group-checks-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.",
+ "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.",
+ "operationId": "merge-group/checks-requested",
+ "tags": [
+ "merge-queue"
+ ],
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-merge-group-checks-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "merge_group",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "merge-group-destroyed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.",
+ "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.",
+ "operationId": "merge-group/destroyed",
+ "tags": [
+ "merge-queue"
+ ],
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-merge-group-destroyed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "merge_group",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "meta-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.",
+ "description": "The webhook was deleted.",
+ "operationId": "meta/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-meta-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "meta",
+ "supported-webhook-types": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "milestone-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.",
+ "description": "A milestone was closed.",
+ "operationId": "milestone/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-milestone-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "milestone",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "milestone-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.",
+ "description": "A milestone was created.",
+ "operationId": "milestone/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-milestone-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "milestone",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "milestone-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.",
+ "description": "A milestone was deleted.",
+ "operationId": "milestone/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-milestone-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "milestone",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "milestone-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.",
+ "description": "A milestone was edited.",
+ "operationId": "milestone/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-milestone-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "milestone",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "milestone-opened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.",
+ "description": "A milestone was opened.",
+ "operationId": "milestone/opened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-milestone-opened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "milestone",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "org-block-blocked": {
+ "post": {
+ "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.",
+ "description": "A user was blocked from the organization.",
+ "operationId": "org-block/blocked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-org-block-blocked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "org_block",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "org-block-unblocked": {
+ "post": {
+ "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.",
+ "description": "A previously blocked user was unblocked from the organization.",
+ "operationId": "org-block/unblocked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-org-block-unblocked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "org_block",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "organization-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "An organization was deleted.",
+ "operationId": "organization/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-organization-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "organization",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "organization-member-added": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A member accepted an invitation to join an organization.",
+ "operationId": "organization/member-added",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-organization-member-added"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "organization",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "organization-member-invited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A member was invited to join the organization.",
+ "operationId": "organization/member-invited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-organization-member-invited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "organization",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "organization-member-removed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A member was removed from the organization.",
+ "operationId": "organization/member-removed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-organization-member-removed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "organization",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "organization-renamed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "The name of an organization was changed.",
+ "operationId": "organization/renamed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-organization-renamed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "organization",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "package-published": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.",
+ "description": "A package was published to a registry.",
+ "operationId": "package/published",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-package-published"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "package",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "package-updated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.",
+ "description": "A previously published package was updated.",
+ "operationId": "package/updated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-package-updated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "package",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "page-build": {
+ "post": {
+ "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.",
+ "operationId": "page-build",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-page-build"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "page_build",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "personal-access-token-request-approved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.",
+ "description": "A fine-grained personal access token request was approved.",
+ "operationId": "personal-access-token-request/approved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "personal_access_token_request",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "integration",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-personal-access-token-request-approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "personal_access_token_request",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "personal-access-token-request-cancelled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.",
+ "description": "A fine-grained personal access token request was cancelled by the requester.",
+ "operationId": "personal-access-token-request/cancelled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "personal_access_token_request",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "integration",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "personal_access_token_request",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "personal-access-token-request-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.",
+ "description": "A fine-grained personal access token request was created.",
+ "operationId": "personal-access-token-request/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "personal_access_token_request",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "integration",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-personal-access-token-request-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "personal_access_token_request",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "personal-access-token-request-denied": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.",
+ "description": "A fine-grained personal access token request was denied.",
+ "operationId": "personal-access-token-request/denied",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "personal_access_token_request",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "integration",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-personal-access-token-request-denied"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "personal_access_token_request",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "ping": {
+ "post": {
+ "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.",
+ "operationId": "ping",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-ping"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ping"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-ping-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/ping-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "ping",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app",
+ "business",
+ "marketplace"
+ ]
+ }
+ }
+ },
+ "project-card-converted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A note in a project (classic) was converted to an issue.",
+ "operationId": "project-card/converted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-card-converted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_card",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-card-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A card was added to a project (classic).",
+ "operationId": "project-card/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-card-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_card",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-card-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A card on a project (classic) was deleted.",
+ "operationId": "project-card/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-card-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_card",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-card-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A note on a project (classic) was edited.",
+ "operationId": "project-card/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-card-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_card",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-card-moved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A card on a project (classic) was moved to another column or to another position in its column.",
+ "operationId": "project-card/moved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-card-moved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_card",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A project (classic) was closed.",
+ "operationId": "project/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-column-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A column was added to a project (classic).",
+ "operationId": "project-column/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-column-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_column",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-column-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A column was deleted from a project (classic).",
+ "operationId": "project-column/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-column-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_column",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-column-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "The name of a column on a project (classic) was changed.",
+ "operationId": "project-column/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-column-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_column",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-column-moved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A column was moved to a new position on a project (classic).",
+ "operationId": "project-column/moved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-column-moved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project_column",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A project (classic) was created.",
+ "operationId": "project/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A project (classic) was deleted.",
+ "operationId": "project/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "The name or description of a project (classic) was changed.",
+ "operationId": "project/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "project-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.",
+ "description": "A project (classic) was closed.",
+ "operationId": "project/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-project-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "project",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "projects-v2-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "A project in the organization was closed.",
+ "operationId": "projects-v2/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-project-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "A project in the organization was created.",
+ "operationId": "projects-v2/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-project-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "A project in the organization was deleted.",
+ "operationId": "projects-v2/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-project-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "The title, description, or README of a project in the organization was changed.",
+ "operationId": "projects-v2/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-project-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-archived": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"",
+ "operationId": "projects-v2-item/archived",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-archived"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-converted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "A draft issue in an organization project was converted to an issue.",
+ "operationId": "projects-v2-item/converted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-converted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "An item was added to a project in the organization.",
+ "operationId": "projects-v2-item/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "An item was deleted from a project in the organization.",
+ "operationId": "projects-v2-item/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.",
+ "operationId": "projects-v2-item/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-reordered": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.",
+ "operationId": "projects-v2-item/reordered",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-reordered"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-item-restored": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"",
+ "operationId": "projects-v2-item/restored",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2-item",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-item-restored"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2_item",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "projects-v2-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).",
+ "description": "A project in the organization was reopened.",
+ "operationId": "projects-v2/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "project-v2",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-projects-v2-project-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "projects_v2",
+ "supported-webhook-types": [
+ "organization"
+ ]
+ }
+ }
+ },
+ "public": {
+ "post": {
+ "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "operationId": "public",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-public"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "public",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-assigned": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was assigned to a user.",
+ "operationId": "pull-request/assigned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-assigned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-auto-merge-disabled": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"",
+ "operationId": "pull-request/auto-merge-disabled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-auto-merge-enabled": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"",
+ "operationId": "pull-request/auto-merge-enabled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-closed": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.",
+ "operationId": "pull-request/closed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-closed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-converted-to-draft": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"",
+ "operationId": "pull-request/converted-to-draft",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-demilestoned": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was removed from a milestone.",
+ "operationId": "pull-request/demilestoned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-demilestoned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-dequeued": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was removed from the merge queue.",
+ "operationId": "pull-request/dequeued",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-dequeued"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
+ "operationId": "pull-request/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-enqueued": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was added to the merge queue.",
+ "operationId": "pull-request/enqueued",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-enqueued"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-labeled": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A label was added to a pull request.",
+ "operationId": "pull-request/labeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-labeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-locked": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"",
+ "operationId": "pull-request/locked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-locked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-milestoned": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was added to a milestone.",
+ "operationId": "pull-request/milestoned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-milestoned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-opened": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request was created",
+ "operationId": "pull-request/opened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-opened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-ready-for-review": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"",
+ "operationId": "pull-request/ready-for-review",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-ready-for-review"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A previously closed pull request was reopened.",
+ "operationId": "pull-request/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-comment-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A comment on a pull request diff was created.",
+ "operationId": "pull-request-review-comment/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-comment-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-comment-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A comment on a pull request diff was deleted.",
+ "operationId": "pull-request-review-comment/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-comment-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "The content of a comment on a pull request diff was changed.",
+ "operationId": "pull-request-review-comment/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review_comment",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-dismissed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A review on a pull request was dismissed.",
+ "operationId": "pull-request-review/dismissed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-dismissed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "The body comment on a pull request review was edited.",
+ "operationId": "pull-request-review/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-request-removed": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A request for review by a person or team was removed from a pull request.",
+ "operationId": "pull-request/review-request-removed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-request-removed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"",
+ "operationId": "pull-request/review-requested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-submitted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A review on a pull request was submitted.",
+ "operationId": "pull-request-review/submitted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-submitted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-thread-resolved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A comment thread on a pull request was marked as resolved.",
+ "operationId": "pull-request-review-thread/resolved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review_thread",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-review-thread-unresolved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A previously resolved comment thread on a pull request was marked as unresolved.",
+ "operationId": "pull-request-review-thread/unresolved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request_review_thread",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-synchronize": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.",
+ "operationId": "pull-request/synchronize",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-synchronize"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-unassigned": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A user was unassigned from a pull request.",
+ "operationId": "pull-request/unassigned",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-unassigned"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-unlabeled": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "A label was removed from a pull request.",
+ "operationId": "pull-request/unlabeled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-unlabeled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "pull-request-unlocked": {
+ "post": {
+ "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
+ "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"",
+ "operationId": "pull-request/unlocked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-pull-request-unlocked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "pull_request",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "push": {
+ "post": {
+ "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.",
+ "operationId": "push",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-push"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "push",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "registry-package-published": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.",
+ "description": "A package was published to a registry.",
+ "operationId": "registry-package/published",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-registry-package-published"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "registry_package",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "registry-package-updated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.",
+ "description": "A package that was previously published to a registry was updated.",
+ "operationId": "registry-package/updated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-registry-package-updated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "registry_package",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.",
+ "operationId": "release/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A release, pre-release, or draft release was deleted.",
+ "operationId": "release/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"",
+ "operationId": "release/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-prereleased": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.",
+ "operationId": "release/prereleased",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-prereleased"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-published": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A release, pre-release, or draft of a release was published.",
+ "operationId": "release/published",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-published"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-released": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A release was published, or a pre-release was changed to a release.",
+ "operationId": "release/released",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-released"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "release-unpublished": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "A release or pre-release was unpublished.",
+ "operationId": "release/unpublished",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-release-unpublished"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "release",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-advisory-published": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.",
+ "description": "A repository security advisory was published.",
+ "operationId": "repository-advisory/published",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-advisory-published"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_advisory",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-advisory-reported": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.",
+ "description": "A private vulnerability report was submitted.",
+ "operationId": "repository-advisory/reported",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-advisory-reported"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_advisory",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-archived": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A repository was archived.",
+ "operationId": "repository/archived",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-archived"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A repository was created.",
+ "operationId": "repository/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.",
+ "operationId": "repository/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-dispatch-sample.collected": {
+ "post": {
+ "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
+ "operationId": "repository-dispatch/sample.collected",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-dispatch-sample"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_dispatch",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "The topics, default branch, description, or homepage of a repository was changed.",
+ "operationId": "repository/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-import": {
+ "post": {
+ "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).",
+ "operationId": "repository-import",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-import"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_import",
+ "supported-webhook-types": [
+ "repository",
+ "organization"
+ ]
+ }
+ }
+ },
+ "repository-privatized": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "The visibility of a repository was changed to `private`.",
+ "operationId": "repository/privatized",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-privatized"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-publicized": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "The visibility of a repository was changed to `public`.",
+ "operationId": "repository/publicized",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-publicized"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-renamed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "The name of a repository was changed.",
+ "operationId": "repository/renamed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-renamed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-ruleset-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
+ "description": "A repository ruleset was created.",
+ "operationId": "repository-ruleset/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-ruleset-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_ruleset",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-ruleset-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
+ "description": "A repository ruleset was deleted.",
+ "operationId": "repository-ruleset/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-ruleset-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_ruleset",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-ruleset-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
+ "description": "A repository ruleset was edited.",
+ "operationId": "repository-ruleset/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-ruleset-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_ruleset",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-transferred": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.",
+ "operationId": "repository/transferred",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-transferred"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-unarchived": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "A previously archived repository was unarchived.",
+ "operationId": "repository/unarchived",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-unarchived"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "repository-vulnerability-alert-create": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.",
+ "description": "A repository vulnerability alert was created.",
+ "operationId": "repository-vulnerability-alert/create",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_vulnerability_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization"
+ ]
+ }
+ }
+ },
+ "repository-vulnerability-alert-dismiss": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.",
+ "description": "A repository vulnerability alert was dismissed.",
+ "operationId": "repository-vulnerability-alert/dismiss",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_vulnerability_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization"
+ ]
+ }
+ }
+ },
+ "repository-vulnerability-alert-reopen": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.",
+ "description": "A previously dismissed or resolved repository vulnerability alert was reopened.",
+ "operationId": "repository-vulnerability-alert/reopen",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_vulnerability_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization"
+ ]
+ }
+ }
+ },
+ "repository-vulnerability-alert-resolve": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.",
+ "description": "A repository vulnerability alert was marked as resolved.",
+ "operationId": "repository-vulnerability-alert/resolve",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "repository_vulnerability_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A secret scanning alert was created.",
+ "operationId": "secret-scanning-alert/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-location-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.",
+ "operationId": "secret-scanning-alert-location/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-alert-location-created"
+ }
+ }
+ },
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert_location",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-reopened": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A previously closed secret scanning alert was reopened.",
+ "operationId": "secret-scanning-alert/reopened",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-resolved": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A secret scanning alert was closed.",
+ "operationId": "secret-scanning-alert/resolved",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-revoked": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A secret scanning alert was marked as revoked.",
+ "operationId": "secret-scanning-alert/revoked",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-validated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.",
+ "description": "A secret scanning alert was validated.",
+ "operationId": "secret-scanning-alert/validated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "secret_scanning_alert",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "security-advisory-published": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"",
+ "description": "A security advisory was published to the GitHub community.",
+ "operationId": "security-advisory/published",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-security-advisory-published"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "security_advisory",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "security-advisory-updated": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"",
+ "description": "The metadata or description of a security advisory was changed.",
+ "operationId": "security-advisory/updated",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-security-advisory-updated"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "security_advisory",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "security-advisory-withdrawn": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"",
+ "description": "A previously published security advisory was withdrawn.",
+ "operationId": "security-advisory/withdrawn",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-security-advisory-withdrawn"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "security_advisory",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "security-and-analysis": {
+ "post": {
+ "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
+ "operationId": "security-and-analysis",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-security-and-analysis"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "security_and_analysis",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "sponsorship-cancelled": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.",
+ "operationId": "sponsorship/cancelled",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-cancelled"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "sponsorship-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.",
+ "operationId": "sponsorship/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "sponsorship-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.",
+ "operationId": "sponsorship/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "sponsorship-pending-cancellation": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.",
+ "operationId": "sponsorship/pending-cancellation",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "sponsorship-pending-tier-change": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.",
+ "operationId": "sponsorship/pending-tier-change",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "sponsorship-tier-changed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"",
+ "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.",
+ "operationId": "sponsorship/tier-changed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-sponsorship-tier-changed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "sponsorship",
+ "supported-webhook-types": [
+ "sponsors_listing"
+ ]
+ }
+ }
+ },
+ "star-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "Someone starred a repository.",
+ "operationId": "star/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-star-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "star",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "star-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "Someone unstarred the repository.",
+ "operationId": "star/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-star-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "star",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "status": {
+ "post": {
+ "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.",
+ "operationId": "status",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-status"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "status",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-add": {
+ "post": {
+ "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "operationId": "team-add",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-add"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team_add",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-added-to-repository": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A team was granted access to a repository.",
+ "operationId": "team/added-to-repository",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-added-to-repository"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-created": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A team was created.",
+ "operationId": "team/created",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-created"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-deleted": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A team was deleted.",
+ "operationId": "team/deleted",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-deleted"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-edited": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "The name, description, or visibility of a team was changed.",
+ "operationId": "team/edited",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-edited"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "team-removed-from-repository": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.",
+ "description": "A team's access to a repository was removed.",
+ "operationId": "team/removed-from-repository",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-team-removed-from-repository"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "team",
+ "supported-webhook-types": [
+ "organization",
+ "business",
+ "app"
+ ]
+ }
+ }
+ },
+ "watch-started": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.",
+ "description": "Someone started watching the repository.",
+ "operationId": "watch/started",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-watch-started"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "watch",
+ "supported-webhook-types": [
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-dispatch": {
+ "post": {
+ "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
+ "operationId": "workflow-dispatch",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-dispatch"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_dispatch",
+ "supported-webhook-types": [
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-job-completed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.",
+ "operationId": "workflow-job/completed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-job-completed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_job",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-job-in-progress": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A job in a workflow run started processing on a runner.",
+ "operationId": "workflow-job/in-progress",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-job-in-progress"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_job",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-job-queued": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A job in a workflow run was created.",
+ "operationId": "workflow-job/queued",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-job-queued"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_job",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-job-waiting": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A job in a workflow run was created and is waiting for approvals.",
+ "operationId": "workflow-job/waiting",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-job-waiting"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_job",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-run-completed": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.",
+ "operationId": "workflow-run/completed",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-run-completed"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_run",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-run-in-progress": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A workflow run started processing on a runner.",
+ "operationId": "workflow-run/in-progress",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-run-in-progress"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_run",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ },
+ "workflow-run-requested": {
+ "post": {
+ "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.",
+ "description": "A workflow run was triggered.",
+ "operationId": "workflow-run/requested",
+ "externalDocs": {
+ "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run"
+ },
+ "parameters": [
+ {
+ "name": "User-Agent",
+ "in": "header",
+ "example": "GitHub-Hookshot/123abc",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Id",
+ "in": "header",
+ "example": 12312312,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Event",
+ "in": "header",
+ "example": "issues",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Id",
+ "in": "header",
+ "example": 123123,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Github-Hook-Installation-Target-Type",
+ "in": "header",
+ "example": "repository",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-GitHub-Delivery",
+ "in": "header",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "X-Hub-Signature-256",
+ "in": "header",
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook-workflow-run-requested"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Return a 200 status to indicate that the data was received successfully"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "category": "webhooks",
+ "subcategory": "workflow_run",
+ "supported-webhook-types": [
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ]
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "root": {
+ "type": "object",
+ "properties": {
+ "current_user_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "current_user_authorizations_html_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "authorizations_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "code_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commit_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "emails_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "emojis_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "feeds_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hub_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "label_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "organization_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "organization_repositories_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "organization_teams_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "public_gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "rate_limit_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "repository_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "current_user_repositories_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "starred_gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "topic_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "user_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "user_organizations_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "user_repositories_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "user_search_url": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "current_user_url",
+ "current_user_authorizations_html_url",
+ "authorizations_url",
+ "code_search_url",
+ "commit_search_url",
+ "emails_url",
+ "emojis_url",
+ "events_url",
+ "feeds_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "hub_url",
+ "issue_search_url",
+ "issues_url",
+ "keys_url",
+ "label_search_url",
+ "notifications_url",
+ "organization_url",
+ "organization_repositories_url",
+ "organization_teams_url",
+ "public_gists_url",
+ "rate_limit_url",
+ "repository_url",
+ "repository_search_url",
+ "current_user_repositories_url",
+ "starred_url",
+ "starred_gists_url",
+ "user_url",
+ "user_organizations_url",
+ "user_repositories_url",
+ "user_search_url"
+ ]
+ },
+ "security-advisory-ecosystems": {
+ "type": "string",
+ "description": "The package's language or package management ecosystem.",
+ "enum": [
+ "rubygems",
+ "npm",
+ "pip",
+ "maven",
+ "nuget",
+ "composer",
+ "go",
+ "rust",
+ "erlang",
+ "actions",
+ "pub",
+ "other",
+ "swift"
+ ]
+ },
+ "simple-user": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "security-advisory-credit-types": {
+ "type": "string",
+ "description": "The type of credit the user is receiving.",
+ "enum": [
+ "analyst",
+ "finder",
+ "reporter",
+ "coordinator",
+ "remediation_developer",
+ "remediation_reviewer",
+ "remediation_verifier",
+ "tool",
+ "sponsor",
+ "other"
+ ]
+ },
+ "global-advisory": {
+ "description": "A GitHub Security Advisory.",
+ "type": "object",
+ "properties": {
+ "ghsa_id": {
+ "type": "string",
+ "description": "The GitHub Security Advisory ID.",
+ "readOnly": true
+ },
+ "cve_id": {
+ "type": "string",
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID.",
+ "nullable": true,
+ "readOnly": true
+ },
+ "url": {
+ "type": "string",
+ "description": "The API URL for the advisory.",
+ "readOnly": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL for the advisory.",
+ "readOnly": true
+ },
+ "repository_advisory_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL for the repository advisory.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of what the advisory entails.",
+ "maxLength": 65535,
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of advisory.",
+ "readOnly": true,
+ "enum": [
+ "reviewed",
+ "unreviewed",
+ "malware"
+ ]
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "unknown"
+ ]
+ },
+ "source_code_location": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL of the advisory's source code.",
+ "nullable": true
+ },
+ "identifiers": {
+ "type": "array",
+ "nullable": true,
+ "readOnly": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of identifier.",
+ "enum": [
+ "CVE",
+ "GHSA"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The identifier value."
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ]
+ }
+ },
+ "references": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string",
+ "description": "URLs with more information regarding the advisory."
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was published, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was last updated, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "github_reviewed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "nvd_published_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "withdrawn_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "description": "The products and respective version ranges affected by the advisory.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "ecosystem": {
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "The range of the package versions affected by the vulnerability.",
+ "nullable": true
+ },
+ "first_patched_version": {
+ "type": "string",
+ "description": "The package version that resolve the vulnerability.",
+ "nullable": true
+ },
+ "vulnerable_functions": {
+ "type": "array",
+ "description": "The functions in the package that are affected by the vulnerability.",
+ "nullable": true,
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package",
+ "vulnerable_version_range",
+ "first_patched_version",
+ "vulnerable_functions"
+ ]
+ }
+ },
+ "cvss": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "vector_string": {
+ "type": "string",
+ "description": "The CVSS vector.",
+ "nullable": true
+ },
+ "score": {
+ "type": "number",
+ "description": "The CVSS score.",
+ "minimum": 0,
+ "maximum": 10,
+ "nullable": true,
+ "readOnly": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string",
+ "description": "The Common Weakness Enumeration (CWE) identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CWE.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ }
+ },
+ "credits": {
+ "type": "array",
+ "description": "The users who contributed to the advisory.",
+ "nullable": true,
+ "readOnly": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "type": {
+ "$ref": "#/components/schemas/security-advisory-credit-types"
+ }
+ },
+ "required": [
+ "user",
+ "type"
+ ]
+ }
+ }
+ },
+ "required": [
+ "ghsa_id",
+ "cve_id",
+ "url",
+ "html_url",
+ "repository_advisory_url",
+ "summary",
+ "description",
+ "type",
+ "severity",
+ "source_code_location",
+ "identifiers",
+ "references",
+ "published_at",
+ "updated_at",
+ "github_reviewed_at",
+ "nvd_published_at",
+ "withdrawn_at",
+ "vulnerabilities",
+ "cvss",
+ "cwes",
+ "credits"
+ ],
+ "additionalProperties": false
+ },
+ "basic-error": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "validation-error-simple": {
+ "title": "Validation Error Simple",
+ "description": "Validation Error Simple",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "nullable-simple-user": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
+ "nullable": true
+ },
+ "integration": {
+ "title": "GitHub app",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "example": 37,
+ "type": "integer"
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "example": "probot-owners",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "example": "Probot Owners",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "The description of the app.",
+ "nullable": true
+ },
+ "external_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://example.com"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/apps/super-ci"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-07-08T16:18:44-04:00"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-07-08T16:18:44-04:00"
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "issues": {
+ "type": "string"
+ },
+ "checks": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "string"
+ },
+ "contents": {
+ "type": "string"
+ },
+ "deployments": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
+ "example": {
+ "issues": "read",
+ "deployments": "write"
+ }
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "example": [
+ "label",
+ "deployment"
+ ],
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "installations_count": {
+ "description": "The number of installations associated with the GitHub app",
+ "example": 5,
+ "type": "integer"
+ },
+ "client_id": {
+ "type": "string",
+ "example": "\"Iv1.25b5d1e65ffc4022\""
+ },
+ "client_secret": {
+ "type": "string",
+ "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
+ },
+ "webhook_secret": {
+ "type": "string",
+ "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"",
+ "nullable": true
+ },
+ "pem": {
+ "type": "string",
+ "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "permissions",
+ "events"
+ ]
+ },
+ "webhook-config-url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "webhook-config-content-type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "webhook-config-secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).",
+ "example": "\"********\""
+ },
+ "webhook-config-insecure-ssl": {
+ "oneOf": [
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "webhook-config": {
+ "title": "Webhook Configuration",
+ "description": "Configuration object of the webhook",
+ "type": "object",
+ "properties": {
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ }
+ }
+ },
+ "hook-delivery-item": {
+ "title": "Simple webhook delivery",
+ "description": "Delivery made by a webhook, without request and response information.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the webhook delivery.",
+ "type": "integer",
+ "example": 42
+ },
+ "guid": {
+ "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).",
+ "type": "string",
+ "example": "58474f00-b361-11eb-836d-0e4f3503ccbe"
+ },
+ "delivered_at": {
+ "description": "Time when the webhook delivery occurred.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2021-05-12T20:33:44Z"
+ },
+ "redelivery": {
+ "description": "Whether the webhook delivery is a redelivery.",
+ "type": "boolean",
+ "example": false
+ },
+ "duration": {
+ "description": "Time spent delivering.",
+ "type": "number",
+ "example": 0.03
+ },
+ "status": {
+ "description": "Describes the response returned after attempting the delivery.",
+ "type": "string",
+ "example": "failed to connect"
+ },
+ "status_code": {
+ "description": "Status code received when delivery was made.",
+ "type": "integer",
+ "example": 502
+ },
+ "event": {
+ "description": "The event that triggered the delivery.",
+ "type": "string",
+ "example": "issues"
+ },
+ "action": {
+ "description": "The type of activity for the event that triggered the delivery.",
+ "type": "string",
+ "example": "opened",
+ "nullable": true
+ },
+ "installation_id": {
+ "description": "The id of the GitHub App installation associated with this event.",
+ "type": "integer",
+ "example": 123,
+ "nullable": true
+ },
+ "repository_id": {
+ "description": "The id of the repository associated with this event.",
+ "type": "integer",
+ "example": 123,
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "guid",
+ "delivered_at",
+ "redelivery",
+ "duration",
+ "status",
+ "status_code",
+ "event",
+ "action",
+ "installation_id",
+ "repository_id"
+ ]
+ },
+ "scim-error": {
+ "title": "Scim Error",
+ "description": "Scim Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ },
+ "documentation_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "detail": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "integer"
+ },
+ "scimType": {
+ "type": "string",
+ "nullable": true
+ },
+ "schemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "validation-error": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "hook-delivery": {
+ "title": "Webhook delivery",
+ "description": "Delivery made by a webhook.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the delivery.",
+ "type": "integer",
+ "example": 42
+ },
+ "guid": {
+ "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).",
+ "type": "string",
+ "example": "58474f00-b361-11eb-836d-0e4f3503ccbe"
+ },
+ "delivered_at": {
+ "description": "Time when the delivery was delivered.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2021-05-12T20:33:44Z"
+ },
+ "redelivery": {
+ "description": "Whether the delivery is a redelivery.",
+ "type": "boolean",
+ "example": false
+ },
+ "duration": {
+ "description": "Time spent delivering.",
+ "type": "number",
+ "example": 0.03
+ },
+ "status": {
+ "description": "Description of the status of the attempted delivery",
+ "type": "string",
+ "example": "failed to connect"
+ },
+ "status_code": {
+ "description": "Status code received when delivery was made.",
+ "type": "integer",
+ "example": 502
+ },
+ "event": {
+ "description": "The event that triggered the delivery.",
+ "type": "string",
+ "example": "issues"
+ },
+ "action": {
+ "description": "The type of activity for the event that triggered the delivery.",
+ "type": "string",
+ "example": "opened",
+ "nullable": true
+ },
+ "installation_id": {
+ "description": "The id of the GitHub App installation associated with this event.",
+ "type": "integer",
+ "example": 123,
+ "nullable": true
+ },
+ "repository_id": {
+ "description": "The id of the repository associated with this event.",
+ "type": "integer",
+ "example": 123,
+ "nullable": true
+ },
+ "url": {
+ "description": "The URL target of the delivery.",
+ "type": "string",
+ "example": "https://www.example.com"
+ },
+ "request": {
+ "type": "object",
+ "properties": {
+ "headers": {
+ "description": "The request headers sent with the webhook delivery.",
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ },
+ "payload": {
+ "description": "The webhook payload.",
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ }
+ },
+ "required": [
+ "headers",
+ "payload"
+ ]
+ },
+ "response": {
+ "type": "object",
+ "properties": {
+ "headers": {
+ "description": "The response headers received when the delivery was made.",
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ },
+ "payload": {
+ "description": "The response payload received.",
+ "type": "string",
+ "nullable": true,
+ "additionalProperties": true
+ }
+ },
+ "required": [
+ "headers",
+ "payload"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "guid",
+ "delivered_at",
+ "redelivery",
+ "duration",
+ "status",
+ "status_code",
+ "event",
+ "action",
+ "installation_id",
+ "repository_id",
+ "request",
+ "response"
+ ]
+ },
+ "enterprise": {
+ "title": "Enterprise",
+ "description": "An enterprise on GitHub.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the enterprise.",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/enterprises/octo-business"
+ },
+ "website_url": {
+ "description": "The enterprise's website URL.",
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the enterprise",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the enterprise.",
+ "type": "string",
+ "example": "Octo Business"
+ },
+ "slug": {
+ "description": "The slug url identifier for the enterprise.",
+ "type": "string",
+ "example": "octo-business"
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time",
+ "example": "2019-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time",
+ "example": "2019-01-26T19:14:43Z"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "slug",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "avatar_url"
+ ]
+ },
+ "integration-installation-request": {
+ "title": "Integration Installation Request",
+ "description": "Request to install an integration on a target",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the request installation.",
+ "type": "integer",
+ "example": 42
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "account": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ {
+ "$ref": "#/components/schemas/enterprise"
+ }
+ ]
+ },
+ "requester": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-07-08T16:18:44-04:00"
+ }
+ },
+ "required": [
+ "id",
+ "account",
+ "requester",
+ "created_at"
+ ]
+ },
+ "app-permissions": {
+ "title": "App Permissions",
+ "type": "object",
+ "description": "The permissions granted to the user access token.",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for checks on code.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "codespaces": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "dependabot_secrets": {
+ "type": "string",
+ "description": "The leve of permission to grant the access token to manage Dependabot secrets.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for deployments and deployment statuses.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for managing repository environments.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for packages published to GitHub Packages.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_custom_properties": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage secret scanning alerts.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage repository secrets.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage just a single file.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for commit statuses.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage Dependabot alerts.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to update GitHub Actions workflow files.",
+ "enum": [
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for organization teams and members.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage access to an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_custom_roles": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for custom repository roles management.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_custom_org_roles": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for custom organization roles management.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_custom_properties": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for custom property management.",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_copilot_seat_management": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.",
+ "enum": [
+ "write"
+ ]
+ },
+ "organization_announcement_banners": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_events": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.",
+ "enum": [
+ "read"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_personal_access_tokens": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_personal_access_token_requests": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for viewing an organization's plan.",
+ "enum": [
+ "read"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage organization secrets.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage users blocked by the organization.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage team discussions and related comments.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "email_addresses": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "followers": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage the followers belonging to a user.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "git_ssh_keys": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage git SSH keys.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "gpg_keys": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "interaction_limits": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "profile": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.",
+ "enum": [
+ "write"
+ ]
+ },
+ "starring": {
+ "type": "string",
+ "description": "The level of permission to grant the access token to list and manage repositories a user is starring.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ },
+ "example": {
+ "contents": "read",
+ "issues": "read",
+ "deployments": "write",
+ "single_file": "read"
+ }
+ },
+ "installation": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ {
+ "$ref": "#/components/schemas/enterprise"
+ }
+ ]
+ },
+ "repository_selection": {
+ "description": "Describe whether all repositories have been selected or there's a selection involved",
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ },
+ "access_tokens_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/app/installations/1/access_tokens"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/installation/repositories"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/organizations/github/settings/installations/1"
+ },
+ "app_id": {
+ "type": "integer",
+ "example": 1
+ },
+ "target_id": {
+ "description": "The ID of the user or organization this token is being scoped to.",
+ "type": "integer"
+ },
+ "target_type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "permissions": {
+ "$ref": "#/components/schemas/app-permissions"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "single_file_name": {
+ "type": "string",
+ "example": "config.yaml",
+ "nullable": true
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ },
+ "app_slug": {
+ "type": "string",
+ "example": "github-actions"
+ },
+ "suspended_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "contact_email": {
+ "type": "string",
+ "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "app_id",
+ "app_slug",
+ "target_id",
+ "target_type",
+ "single_file_name",
+ "repository_selection",
+ "access_tokens_url",
+ "html_url",
+ "repositories_url",
+ "events",
+ "account",
+ "permissions",
+ "created_at",
+ "updated_at",
+ "suspended_by",
+ "suspended_at"
+ ]
+ },
+ "nullable-license-simple": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A repository on GitHub.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "deprecated": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_update_branch": {
+ "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:42Z\""
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean",
+ "description": "Whether anonymous git access is enabled for this repository"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "installation-token": {
+ "title": "Installation Token",
+ "description": "Authentication token for a GitHub App installed on a user or org.",
+ "type": "object",
+ "properties": {
+ "token": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string"
+ },
+ "permissions": {
+ "$ref": "#/components/schemas/app-permissions"
+ },
+ "repository_selection": {
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "single_file": {
+ "type": "string",
+ "example": "README.md"
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "required": [
+ "token",
+ "expires_at"
+ ]
+ },
+ "nullable-scoped-installation": {
+ "title": "Scoped Installation",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "$ref": "#/components/schemas/app-permissions"
+ },
+ "repository_selection": {
+ "description": "Describe whether all repositories have been selected or there's a selection involved",
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ },
+ "single_file_name": {
+ "type": "string",
+ "example": "config.yaml",
+ "nullable": true
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ],
+ "nullable": true
+ },
+ "authorization": {
+ "title": "Authorization",
+ "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ },
+ "token": {
+ "type": "string"
+ },
+ "token_last_eight": {
+ "type": "string",
+ "nullable": true
+ },
+ "hashed_token": {
+ "type": "string",
+ "nullable": true
+ },
+ "app": {
+ "type": "object",
+ "properties": {
+ "client_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "client_id",
+ "name",
+ "url"
+ ]
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "note_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fingerprint": {
+ "type": "string",
+ "nullable": true
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/nullable-scoped-installation"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at",
+ "expires_at"
+ ]
+ },
+ "simple-classroom-repository": {
+ "title": "Simple Classroom Repository",
+ "description": "A GitHub repository view for Classroom",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269,
+ "description": "A unique identifier of the repository."
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World",
+ "description": "The full, globally unique name of the repository."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World",
+ "description": "The URL to view the repository on GitHub.com."
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "description": "The GraphQL identifier of the repository."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Whether the repository is private."
+ },
+ "default_branch": {
+ "type": "string",
+ "example": "main",
+ "description": "The default branch for the repository."
+ }
+ },
+ "required": [
+ "id",
+ "full_name",
+ "html_url",
+ "node_id",
+ "private",
+ "default_branch"
+ ]
+ },
+ "simple-classroom-organization": {
+ "title": "Organization Simple for Classroom",
+ "description": "A GitHub organization.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/github"
+ },
+ "name": {
+ "type": "string",
+ "example": "Github - Code thigns happen here",
+ "nullable": true
+ },
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "node_id",
+ "html_url",
+ "name",
+ "avatar_url"
+ ]
+ },
+ "classroom": {
+ "title": "Classroom",
+ "description": "A GitHub Classroom classroom",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the classroom.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the classroom.",
+ "type": "string",
+ "example": "Programming Elixir"
+ },
+ "archived": {
+ "description": "Whether classroom is archived.",
+ "type": "boolean",
+ "example": false
+ },
+ "organization": {
+ "$ref": "#/components/schemas/simple-classroom-organization"
+ },
+ "url": {
+ "description": "The URL of the classroom on GitHub Classroom.",
+ "type": "string",
+ "example": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "archived",
+ "organization",
+ "url"
+ ]
+ },
+ "classroom-assignment": {
+ "title": "Classroom Assignment",
+ "description": "A GitHub Classroom assignment",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository.",
+ "type": "integer",
+ "example": 42
+ },
+ "public_repo": {
+ "description": "Whether an accepted assignment creates a public repository.",
+ "type": "boolean",
+ "example": true
+ },
+ "title": {
+ "description": "Assignment title.",
+ "type": "string",
+ "example": "Intro to Binaries"
+ },
+ "type": {
+ "description": "Whether it's a group assignment or individual assignment.",
+ "type": "string",
+ "example": "individual",
+ "enum": [
+ "individual",
+ "group"
+ ]
+ },
+ "invite_link": {
+ "description": "The link that a student can use to accept the assignment.",
+ "type": "string",
+ "example": "https://classroom.github.com/a/Lx7jiUgx"
+ },
+ "invitations_enabled": {
+ "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.",
+ "type": "boolean",
+ "example": true
+ },
+ "slug": {
+ "description": "Sluggified name of the assignment.",
+ "type": "string",
+ "example": "intro-to-binaries"
+ },
+ "students_are_repo_admins": {
+ "description": "Whether students are admins on created repository when a student accepts the assignment.",
+ "type": "boolean",
+ "example": true
+ },
+ "feedback_pull_requests_enabled": {
+ "description": "Whether feedback pull request will be created when a student accepts the assignment.",
+ "type": "boolean",
+ "example": true
+ },
+ "max_teams": {
+ "description": "The maximum allowable teams for the assignment.",
+ "nullable": true,
+ "type": "integer",
+ "example": 0
+ },
+ "max_members": {
+ "description": "The maximum allowable members per team.",
+ "nullable": true,
+ "type": "integer",
+ "example": 0
+ },
+ "editor": {
+ "description": "The selected editor for the assignment.",
+ "type": "string",
+ "example": "codespaces"
+ },
+ "accepted": {
+ "description": "The number of students that have accepted the assignment.",
+ "type": "integer",
+ "example": 25
+ },
+ "submitted": {
+ "description": "The number of students that have submitted the assignment.",
+ "type": "integer",
+ "example": 10
+ },
+ "passing": {
+ "description": "The number of students that have passed the assignment.",
+ "type": "integer",
+ "example": 10
+ },
+ "language": {
+ "description": "The programming language used in the assignment.",
+ "type": "string",
+ "example": "elixir"
+ },
+ "deadline": {
+ "description": "The time at which the assignment is due.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "starter_code_repository": {
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ },
+ "classroom": {
+ "$ref": "#/components/schemas/classroom"
+ }
+ },
+ "required": [
+ "id",
+ "public_repo",
+ "title",
+ "type",
+ "invite_link",
+ "invitations_enabled",
+ "slug",
+ "students_are_repo_admins",
+ "feedback_pull_requests_enabled",
+ "max_teams",
+ "max_members",
+ "editor",
+ "accepted",
+ "submitted",
+ "passing",
+ "language",
+ "deadline",
+ "starter_code_repository",
+ "classroom"
+ ]
+ },
+ "simple-classroom-user": {
+ "title": "Simple Classroom User",
+ "description": "A GitHub user simplified for Classroom.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "avatar_url",
+ "html_url"
+ ]
+ },
+ "simple-classroom": {
+ "title": "Simple Classroom",
+ "description": "A GitHub Classroom classroom",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the classroom.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the classroom.",
+ "type": "string",
+ "example": "Programming Elixir"
+ },
+ "archived": {
+ "description": "Returns whether classroom is archived or not.",
+ "type": "boolean",
+ "example": false
+ },
+ "url": {
+ "description": "The url of the classroom on GitHub Classroom.",
+ "type": "string",
+ "example": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "archived",
+ "url"
+ ]
+ },
+ "simple-classroom-assignment": {
+ "title": "Simple Classroom Assignment",
+ "description": "A GitHub Classroom assignment",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository.",
+ "type": "integer",
+ "example": 42
+ },
+ "public_repo": {
+ "description": "Whether an accepted assignment creates a public repository.",
+ "type": "boolean",
+ "example": true
+ },
+ "title": {
+ "description": "Assignment title.",
+ "type": "string",
+ "example": "Intro to Binaries"
+ },
+ "type": {
+ "description": "Whether it's a Group Assignment or Individual Assignment.",
+ "type": "string",
+ "example": "individual",
+ "enum": [
+ "individual",
+ "group"
+ ]
+ },
+ "invite_link": {
+ "description": "The link that a student can use to accept the assignment.",
+ "type": "string",
+ "example": "https://classroom.github.com/a/Lx7jiUgx"
+ },
+ "invitations_enabled": {
+ "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.",
+ "type": "boolean",
+ "example": true
+ },
+ "slug": {
+ "description": "Sluggified name of the assignment.",
+ "type": "string",
+ "example": "intro-to-binaries"
+ },
+ "students_are_repo_admins": {
+ "description": "Whether students are admins on created repository on accepted assignment.",
+ "type": "boolean",
+ "example": true
+ },
+ "feedback_pull_requests_enabled": {
+ "description": "Whether feedback pull request will be created on assignment acceptance.",
+ "type": "boolean",
+ "example": true
+ },
+ "max_teams": {
+ "description": "The maximum allowable teams for the assignment.",
+ "nullable": true,
+ "type": "integer",
+ "example": 0
+ },
+ "max_members": {
+ "description": "The maximum allowable members per team.",
+ "nullable": true,
+ "type": "integer",
+ "example": 0
+ },
+ "editor": {
+ "description": "The selected editor for the assignment.",
+ "type": "string",
+ "example": "codespaces"
+ },
+ "accepted": {
+ "description": "The number of students that have accepted the assignment.",
+ "type": "integer",
+ "example": 25
+ },
+ "submitted": {
+ "description": "The number of students that have submitted the assignment.",
+ "type": "integer",
+ "example": 10
+ },
+ "passing": {
+ "description": "The number of students that have passed the assignment.",
+ "type": "integer",
+ "example": 10
+ },
+ "language": {
+ "description": "The programming language used in the assignment.",
+ "type": "string",
+ "example": "elixir"
+ },
+ "deadline": {
+ "description": "The time at which the assignment is due.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "classroom": {
+ "$ref": "#/components/schemas/simple-classroom"
+ }
+ },
+ "required": [
+ "id",
+ "public_repo",
+ "title",
+ "type",
+ "invite_link",
+ "invitations_enabled",
+ "slug",
+ "students_are_repo_admins",
+ "feedback_pull_requests_enabled",
+ "editor",
+ "accepted",
+ "submitted",
+ "passing",
+ "language",
+ "deadline",
+ "classroom"
+ ]
+ },
+ "classroom-accepted-assignment": {
+ "title": "Classroom Accepted Assignment",
+ "description": "A GitHub Classroom accepted assignment",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository.",
+ "type": "integer",
+ "example": 42
+ },
+ "submitted": {
+ "description": "Whether an accepted assignment has been submitted.",
+ "type": "boolean",
+ "example": true
+ },
+ "passing": {
+ "description": "Whether a submission passed.",
+ "type": "boolean",
+ "example": true
+ },
+ "commit_count": {
+ "description": "Count of student commits.",
+ "type": "integer",
+ "example": 5
+ },
+ "grade": {
+ "description": "Most recent grade.",
+ "type": "string",
+ "example": "10/10"
+ },
+ "students": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-classroom-user"
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ },
+ "assignment": {
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ }
+ },
+ "required": [
+ "id",
+ "submitted",
+ "passing",
+ "commit_count",
+ "grade",
+ "students",
+ "repository",
+ "assignment"
+ ]
+ },
+ "classroom-assignment-grade": {
+ "title": "Classroom Assignment Grade",
+ "description": "Grade for a student or groups GitHub Classroom assignment",
+ "type": "object",
+ "properties": {
+ "assignment_name": {
+ "description": "Name of the assignment",
+ "type": "string"
+ },
+ "assignment_url": {
+ "description": "URL of the assignment",
+ "type": "string"
+ },
+ "starter_code_url": {
+ "description": "URL of the starter code for the assignment",
+ "type": "string"
+ },
+ "github_username": {
+ "description": "GitHub username of the student",
+ "type": "string"
+ },
+ "roster_identifier": {
+ "description": "Roster identifier of the student",
+ "type": "string"
+ },
+ "student_repository_name": {
+ "description": "Name of the student's assignment repository",
+ "type": "string"
+ },
+ "student_repository_url": {
+ "description": "URL of the student's assignment repository",
+ "type": "string"
+ },
+ "submission_timestamp": {
+ "description": "Timestamp of the student's assignment submission",
+ "type": "string"
+ },
+ "points_awarded": {
+ "description": "Number of points awarded to the student",
+ "type": "integer"
+ },
+ "points_available": {
+ "description": "Number of points available for the assignment",
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "If a group assignment, name of the group the student is in",
+ "type": "string"
+ }
+ },
+ "required": [
+ "assignment_name",
+ "assignment_url",
+ "starter_code_url",
+ "github_username",
+ "roster_identifier",
+ "student_repository_name",
+ "student_repository_url",
+ "submission_timestamp",
+ "points_awarded",
+ "points_available"
+ ]
+ },
+ "code-of-conduct": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "alert-number": {
+ "type": "integer",
+ "description": "The security alert number.",
+ "readOnly": true
+ },
+ "dependabot-alert-package": {
+ "type": "object",
+ "description": "Details for the vulnerable package.",
+ "readOnly": true,
+ "properties": {
+ "ecosystem": {
+ "type": "string",
+ "description": "The package's language or package management ecosystem.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ],
+ "additionalProperties": false
+ },
+ "dependabot-alert-security-vulnerability": {
+ "type": "object",
+ "description": "Details pertaining to one vulnerable version range for the advisory.",
+ "readOnly": true,
+ "properties": {
+ "package": {
+ "$ref": "#/components/schemas/dependabot-alert-package"
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the vulnerability.",
+ "readOnly": true,
+ "enum": [
+ "low",
+ "medium",
+ "high",
+ "critical"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "Conditions that identify vulnerable versions of this vulnerability's package.",
+ "readOnly": true
+ },
+ "first_patched_version": {
+ "type": "object",
+ "description": "Details pertaining to the package version that patches this vulnerability.",
+ "readOnly": true,
+ "nullable": true,
+ "properties": {
+ "identifier": {
+ "type": "string",
+ "description": "The package version that patches this vulnerability.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "package",
+ "severity",
+ "vulnerable_version_range",
+ "first_patched_version"
+ ],
+ "additionalProperties": false
+ },
+ "dependabot-alert-security-advisory": {
+ "type": "object",
+ "description": "Details for the GitHub Security Advisory.",
+ "readOnly": true,
+ "properties": {
+ "ghsa_id": {
+ "type": "string",
+ "description": "The unique GitHub Security Advisory ID assigned to the advisory.",
+ "readOnly": true
+ },
+ "cve_id": {
+ "type": "string",
+ "description": "The unique CVE ID assigned to the advisory.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short, plain text summary of the advisory.",
+ "readOnly": true,
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A long-form Markdown-supported description of the advisory.",
+ "readOnly": true
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "description": "Vulnerable version range information for the advisory.",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
+ }
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory.",
+ "readOnly": true,
+ "enum": [
+ "low",
+ "medium",
+ "high",
+ "critical"
+ ]
+ },
+ "cvss": {
+ "type": "object",
+ "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
+ "readOnly": true,
+ "properties": {
+ "score": {
+ "type": "number",
+ "description": "The overall CVSS score of the advisory.",
+ "minimum": 0,
+ "maximum": 10,
+ "readOnly": true
+ },
+ "vector_string": {
+ "type": "string",
+ "description": "The full CVSS vector string for the advisory.",
+ "readOnly": true,
+ "nullable": true
+ }
+ },
+ "required": [
+ "score",
+ "vector_string"
+ ],
+ "additionalProperties": false
+ },
+ "cwes": {
+ "type": "array",
+ "description": "Details for the advisory pertaining to Common Weakness Enumeration.",
+ "readOnly": true,
+ "items": {
+ "type": "object",
+ "description": "A CWE weakness assigned to the advisory.",
+ "readOnly": true,
+ "properties": {
+ "cwe_id": {
+ "type": "string",
+ "description": "The unique CWE ID.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The short, plain text name of the CWE.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "identifiers": {
+ "type": "array",
+ "description": "Values that identify this advisory among security information sources.",
+ "readOnly": true,
+ "items": {
+ "type": "object",
+ "description": "An advisory identifier.",
+ "readOnly": true,
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of advisory identifier.",
+ "readOnly": true,
+ "enum": [
+ "CVE",
+ "GHSA"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the advisory identifer.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "value",
+ "type"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "references": {
+ "type": "array",
+ "description": "Links to additional advisory information.",
+ "readOnly": true,
+ "items": {
+ "type": "object",
+ "description": "A link to additional advisory information.",
+ "readOnly": true,
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The URL of the reference.",
+ "format": "uri",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "published_at": {
+ "type": "string",
+ "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "string",
+ "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "withdrawn_at": {
+ "type": "string",
+ "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true,
+ "nullable": true
+ }
+ },
+ "required": [
+ "ghsa_id",
+ "cve_id",
+ "summary",
+ "description",
+ "vulnerabilities",
+ "severity",
+ "cvss",
+ "cwes",
+ "identifiers",
+ "references",
+ "published_at",
+ "updated_at",
+ "withdrawn_at"
+ ],
+ "additionalProperties": false
+ },
+ "alert-url": {
+ "type": "string",
+ "description": "The REST API URL of the alert resource.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "alert-html-url": {
+ "type": "string",
+ "description": "The GitHub URL of the alert resource.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "alert-created-at": {
+ "type": "string",
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "alert-updated-at": {
+ "type": "string",
+ "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "alert-dismissed-at": {
+ "type": "string",
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true,
+ "nullable": true
+ },
+ "alert-fixed-at": {
+ "type": "string",
+ "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true,
+ "nullable": true
+ },
+ "alert-auto-dismissed-at": {
+ "type": "string",
+ "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true,
+ "nullable": true
+ },
+ "simple-repository": {
+ "title": "Simple Repository",
+ "description": "A GitHub repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269,
+ "description": "A unique identifier of the repository."
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "description": "The GraphQL identifier of the repository."
+ },
+ "name": {
+ "type": "string",
+ "example": "Hello-World",
+ "description": "The name of the repository."
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World",
+ "description": "The full, globally unique, name of the repository."
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Whether the repository is private."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World",
+ "description": "The URL to view the repository on GitHub.com."
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true,
+ "description": "The repository description."
+ },
+ "fork": {
+ "type": "boolean",
+ "description": "Whether the repository is a fork."
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "description": "The URL to get more information about the repository from the GitHub API."
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "description": "A template for the API URL to download the repository as an archive."
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "description": "A template for the API URL to list the available assignees for issues in the repository."
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "description": "A template for the API URL to create or retrieve a raw Git blob in the repository."
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "description": "A template for the API URL to get information about branches in the repository."
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "description": "A template for the API URL to get information about collaborators of the repository."
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "description": "A template for the API URL to get information about comments on the repository."
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "description": "A template for the API URL to get information about commits on the repository."
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "description": "A template for the API URL to compare two commits or refs."
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "description": "A template for the API URL to get the contents of the repository."
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "description": "A template for the API URL to list the contributors to the repository."
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "description": "The API URL to list the deployments of the repository."
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "description": "The API URL to list the downloads on the repository."
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/events",
+ "description": "The API URL to list the events of the repository."
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "description": "The API URL to list the forks of the repository."
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "description": "A template for the API URL to get information about Git commits of the repository."
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "description": "A template for the API URL to get information about Git refs of the repository."
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "description": "A template for the API URL to get information about Git tags of the repository."
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "description": "A template for the API URL to get information about issue comments on the repository."
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "description": "A template for the API URL to get information about issue events on the repository."
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "description": "A template for the API URL to get information about issues on the repository."
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "description": "A template for the API URL to get information about deploy keys on the repository."
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "description": "A template for the API URL to get information about labels of the repository."
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "description": "The API URL to get information about the languages of the repository."
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "description": "The API URL to merge branches in the repository."
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "description": "A template for the API URL to get information about milestones of the repository."
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "description": "A template for the API URL to get information about notifications on the repository."
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "description": "A template for the API URL to get information about pull requests on the repository."
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "description": "A template for the API URL to get information about releases on the repository."
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "description": "The API URL to list the stargazers on the repository."
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "description": "A template for the API URL to get information about statuses of a commit."
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "description": "The API URL to list the subscribers on the repository."
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "description": "The API URL to subscribe to notifications for this repository."
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "description": "The API URL to get information about tags on the repository."
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "description": "The API URL to list the teams on the repository."
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "description": "A template for the API URL to create or retrieve a raw Git tree of the repository."
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "description": "The API URL to list the hooks on the repository."
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "dependabot-alert-with-repository": {
+ "type": "object",
+ "description": "A Dependabot alert.",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the Dependabot alert.",
+ "readOnly": true,
+ "enum": [
+ "auto_dismissed",
+ "dismissed",
+ "fixed",
+ "open"
+ ]
+ },
+ "dependency": {
+ "type": "object",
+ "description": "Details for the vulnerable dependency.",
+ "readOnly": true,
+ "properties": {
+ "package": {
+ "$ref": "#/components/schemas/dependabot-alert-package"
+ },
+ "manifest_path": {
+ "type": "string",
+ "description": "The full path to the dependency manifest file, relative to the root of the repository.",
+ "readOnly": true
+ },
+ "scope": {
+ "type": "string",
+ "description": "The execution scope of the vulnerable dependency.",
+ "readOnly": true,
+ "nullable": true,
+ "enum": [
+ "development",
+ "runtime"
+ ]
+ }
+ }
+ },
+ "security_advisory": {
+ "$ref": "#/components/schemas/dependabot-alert-security-advisory"
+ },
+ "security_vulnerability": {
+ "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/alert-updated-at"
+ },
+ "dismissed_at": {
+ "$ref": "#/components/schemas/alert-dismissed-at"
+ },
+ "dismissed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "dismissed_reason": {
+ "type": "string",
+ "description": "The reason that the alert was dismissed.",
+ "nullable": true,
+ "enum": [
+ "fix_started",
+ "inaccurate",
+ "no_bandwidth",
+ "not_used",
+ "tolerable_risk"
+ ]
+ },
+ "dismissed_comment": {
+ "type": "string",
+ "description": "An optional comment associated with the alert's dismissal.",
+ "nullable": true,
+ "maxLength": 280
+ },
+ "fixed_at": {
+ "$ref": "#/components/schemas/alert-fixed-at"
+ },
+ "auto_dismissed_at": {
+ "$ref": "#/components/schemas/alert-auto-dismissed-at"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/simple-repository"
+ }
+ },
+ "required": [
+ "number",
+ "state",
+ "dependency",
+ "security_advisory",
+ "security_vulnerability",
+ "url",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "dismissed_at",
+ "dismissed_by",
+ "dismissed_reason",
+ "dismissed_comment",
+ "fixed_at",
+ "repository"
+ ],
+ "additionalProperties": false
+ },
+ "nullable-alert-updated-at": {
+ "type": "string",
+ "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true,
+ "nullable": true
+ },
+ "secret-scanning-alert-state": {
+ "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "resolved"
+ ]
+ },
+ "secret-scanning-alert-resolution": {
+ "type": "string",
+ "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
+ "nullable": true,
+ "enum": [
+ "false_positive",
+ "wont_fix",
+ "revoked",
+ "used_in_tests"
+ ]
+ },
+ "organization-secret-scanning-alert": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/nullable-alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "locations_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The REST API URL of the code locations for this alert."
+ },
+ "state": {
+ "$ref": "#/components/schemas/secret-scanning-alert-state"
+ },
+ "resolution": {
+ "$ref": "#/components/schemas/secret-scanning-alert-resolution"
+ },
+ "resolved_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "resolved_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "secret_type": {
+ "type": "string",
+ "description": "The type of secret that secret scanning detected."
+ },
+ "secret_type_display_name": {
+ "type": "string",
+ "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "The secret that was detected."
+ },
+ "repository": {
+ "$ref": "#/components/schemas/simple-repository"
+ },
+ "push_protection_bypassed": {
+ "type": "boolean",
+ "description": "Whether push protection was bypassed for the detected secret.",
+ "nullable": true
+ },
+ "push_protection_bypassed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "push_protection_bypassed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "resolution_comment": {
+ "type": "string",
+ "description": "The comment that was optionally added when this alert was closed",
+ "nullable": true
+ },
+ "validity": {
+ "type": "string",
+ "description": "The token status as of the latest validity check.",
+ "enum": [
+ "active",
+ "inactive",
+ "unknown"
+ ]
+ }
+ }
+ },
+ "actor": {
+ "title": "Actor",
+ "description": "Actor",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "display_login": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "gravatar_id",
+ "url",
+ "avatar_url"
+ ]
+ },
+ "nullable-milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/milestones/v1.0"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1002604
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDk6TWlsZXN0b25lMTAwMjYwNA=="
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer",
+ "example": 42
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "example": "open",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open"
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "example": "v1.0",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "Tracking milestone for version 1.0",
+ "nullable": true
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 4
+ },
+ "closed_issues": {
+ "type": "integer",
+ "example": 8
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-10T20:09:31Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2014-03-03T18:58:10Z"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2013-02-12T13:22:01Z",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-10-09T23:39:01Z",
+ "nullable": true
+ }
+ },
+ "required": [
+ "closed_issues",
+ "creator",
+ "description",
+ "due_on",
+ "closed_at",
+ "id",
+ "node_id",
+ "labels_url",
+ "html_url",
+ "number",
+ "open_issues",
+ "state",
+ "title",
+ "url",
+ "created_at",
+ "updated_at"
+ ],
+ "nullable": true
+ },
+ "nullable-integration": {
+ "title": "GitHub app",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "example": 37,
+ "type": "integer"
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "example": "probot-owners",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "example": "Probot Owners",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "The description of the app.",
+ "nullable": true
+ },
+ "external_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://example.com"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/apps/super-ci"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-07-08T16:18:44-04:00"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-07-08T16:18:44-04:00"
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "issues": {
+ "type": "string"
+ },
+ "checks": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "string"
+ },
+ "contents": {
+ "type": "string"
+ },
+ "deployments": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
+ "example": {
+ "issues": "read",
+ "deployments": "write"
+ }
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "example": [
+ "label",
+ "deployment"
+ ],
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "installations_count": {
+ "description": "The number of installations associated with the GitHub app",
+ "example": 5,
+ "type": "integer"
+ },
+ "client_id": {
+ "type": "string",
+ "example": "\"Iv1.25b5d1e65ffc4022\""
+ },
+ "client_secret": {
+ "type": "string",
+ "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
+ },
+ "webhook_secret": {
+ "type": "string",
+ "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"",
+ "nullable": true
+ },
+ "pem": {
+ "type": "string",
+ "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "permissions",
+ "events"
+ ],
+ "nullable": true
+ },
+ "author-association": {
+ "title": "author_association",
+ "type": "string",
+ "example": "OWNER",
+ "description": "How the author is associated with the repository.",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "reaction-rollup": {
+ "title": "Reaction Rollup",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "example": "https://api.github.com/repositories/42/issues/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "number": {
+ "description": "Number uniquely identifying the issue within its repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "example": "open",
+ "type": "string"
+ },
+ "state_reason": {
+ "description": "The reason for the current state",
+ "example": "not_planned",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
+ },
+ "title": {
+ "description": "Title of the issue",
+ "example": "Widget creation fails in Safari on OS X 10.8",
+ "type": "string"
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?",
+ "type": "string",
+ "nullable": true
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "labels": {
+ "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository",
+ "example": [
+ "bug",
+ "registration"
+ ],
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ },
+ "default": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/nullable-milestone"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "merged_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "diff_url",
+ "html_url",
+ "patch_url",
+ "url"
+ ]
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "closed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "assignee",
+ "closed_at",
+ "comments",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "labels",
+ "labels_url",
+ "milestone",
+ "number",
+ "repository_url",
+ "state",
+ "locked",
+ "title",
+ "url",
+ "user",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "issue-comment": {
+ "title": "Issue Comment",
+ "description": "Comments provide a way for people to collaborate on an issue.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the issue comment",
+ "example": 42,
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the issue comment",
+ "example": "https://api.github.com/repositories/42/issues/comments/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "body": {
+ "description": "Contents of the issue comment",
+ "example": "What version of Safari were you using when you observed this bug?",
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "event": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "actor": {
+ "$ref": "#/components/schemas/actor"
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "$ref": "#/components/schemas/actor"
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/issue"
+ },
+ "comment": {
+ "$ref": "#/components/schemas/issue-comment"
+ },
+ "pages": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "page_name": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string",
+ "nullable": true
+ },
+ "action": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "type",
+ "actor",
+ "repo",
+ "payload",
+ "public",
+ "created_at"
+ ]
+ },
+ "link-with-type": {
+ "title": "Link With Type",
+ "description": "Hypermedia Link with Type",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href",
+ "type"
+ ]
+ },
+ "feed": {
+ "title": "Feed",
+ "description": "Feed",
+ "type": "object",
+ "properties": {
+ "timeline_url": {
+ "type": "string",
+ "example": "https://github.com/timeline"
+ },
+ "user_url": {
+ "type": "string",
+ "example": "https://github.com/{user}"
+ },
+ "current_user_public_url": {
+ "type": "string",
+ "example": "https://github.com/octocat"
+ },
+ "current_user_url": {
+ "type": "string",
+ "example": "https://github.com/octocat.private?token=abc123"
+ },
+ "current_user_actor_url": {
+ "type": "string",
+ "example": "https://github.com/octocat.private.actor?token=abc123"
+ },
+ "current_user_organization_url": {
+ "type": "string",
+ "example": "https://github.com/octocat-org"
+ },
+ "current_user_organization_urls": {
+ "type": "array",
+ "example": [
+ "https://github.com/organizations/github/octocat.private.atom?token=abc123"
+ ],
+ "items": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "security_advisories_url": {
+ "type": "string",
+ "example": "https://github.com/security-advisories"
+ },
+ "repository_discussions_url": {
+ "type": "string",
+ "example": "https://github.com/{user}/{repo}/discussions",
+ "description": "A feed of discussions for a given repository."
+ },
+ "repository_discussions_category_url": {
+ "type": "string",
+ "example": "https://github.com/{user}/{repo}/discussions/categories/{category}",
+ "description": "A feed of discussions for a given repository and category."
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "timeline": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "user": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "security_advisories": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "current_user": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "current_user_public": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "current_user_actor": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "current_user_organization": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "current_user_organizations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/link-with-type"
+ }
+ },
+ "repository_discussions": {
+ "$ref": "#/components/schemas/link-with-type"
+ },
+ "repository_discussions_category": {
+ "$ref": "#/components/schemas/link-with-type"
+ }
+ },
+ "required": [
+ "timeline",
+ "user"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "timeline_url",
+ "user_url"
+ ]
+ },
+ "base-gist": {
+ "title": "Base Gist",
+ "description": "Base Gist",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "git_pull_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_push_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "files": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "filename": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "raw_url": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "history": {
+ "type": "array",
+ "items": {
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "forks_url",
+ "commits_url",
+ "git_pull_url",
+ "git_push_url",
+ "html_url",
+ "comments_url",
+ "public",
+ "description",
+ "comments",
+ "user",
+ "files",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "public-user": {
+ "title": "Public User",
+ "description": "Public User",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "blog": {
+ "type": "string",
+ "nullable": true
+ },
+ "location": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "nullable": true
+ },
+ "hireable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "bio": {
+ "type": "string",
+ "nullable": true
+ },
+ "twitter_username": {
+ "type": "string",
+ "nullable": true
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "collaborators": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "collaborators",
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 1
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 3
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "bio",
+ "blog",
+ "company",
+ "email",
+ "followers",
+ "following",
+ "hireable",
+ "location",
+ "name",
+ "public_gists",
+ "public_repos",
+ "created_at",
+ "updated_at"
+ ],
+ "additionalProperties": false
+ },
+ "gist-history": {
+ "title": "Gist History",
+ "description": "Gist History",
+ "type": "object",
+ "properties": {
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "version": {
+ "type": "string"
+ },
+ "committed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "change_status": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer"
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "deletions": {
+ "type": "integer"
+ }
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "gist-simple": {
+ "title": "Gist Simple",
+ "description": "Gist Simple",
+ "type": "object",
+ "properties": {
+ "forks": {
+ "deprecated": true,
+ "nullable": true,
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "$ref": "#/components/schemas/public-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ }
+ },
+ "history": {
+ "deprecated": true,
+ "nullable": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/gist-history"
+ }
+ },
+ "fork_of": {
+ "nullable": true,
+ "title": "Gist",
+ "description": "Gist",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "git_pull_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_push_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "files": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "filename": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "raw_url": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "history": {
+ "type": "array",
+ "items": {
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "forks_url",
+ "commits_url",
+ "git_pull_url",
+ "git_push_url",
+ "html_url",
+ "comments_url",
+ "public",
+ "description",
+ "comments",
+ "user",
+ "files",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "url": {
+ "type": "string"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "git_pull_url": {
+ "type": "string"
+ },
+ "git_push_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "files": {
+ "type": "object",
+ "additionalProperties": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "filename": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "raw_url": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "content": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "user": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ "gist-comment": {
+ "title": "Gist Comment",
+ "description": "A comment made to a gist.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkdpc3RDb21tZW50MQ=="
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1"
+ },
+ "body": {
+ "description": "The comment text.",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-18T23:23:56Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-18T23:23:56Z"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "gist-commit": {
+ "title": "Gist Commit",
+ "description": "Gist Commit",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f"
+ },
+ "version": {
+ "type": "string",
+ "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "change_status": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer"
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "deletions": {
+ "type": "integer"
+ }
+ }
+ },
+ "committed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2010-04-14T02:15:15Z"
+ }
+ },
+ "required": [
+ "url",
+ "user",
+ "version",
+ "committed_at",
+ "change_status"
+ ]
+ },
+ "gitignore-template": {
+ "title": "Gitignore Template",
+ "description": "Gitignore Template",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "C"
+ },
+ "source": {
+ "type": "string",
+ "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
+ }
+ },
+ "required": [
+ "name",
+ "source"
+ ]
+ },
+ "license-simple": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ]
+ },
+ "license": {
+ "title": "License",
+ "description": "License",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "spdx_id": {
+ "type": "string",
+ "example": "MIT",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://choosealicense.com/licenses/mit/"
+ },
+ "description": {
+ "type": "string",
+ "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty."
+ },
+ "implementation": {
+ "type": "string",
+ "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders."
+ },
+ "permissions": {
+ "type": "array",
+ "example": [
+ "commercial-use",
+ "modifications",
+ "distribution",
+ "sublicense",
+ "private-use"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "conditions": {
+ "type": "array",
+ "example": [
+ "include-copyright"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "limitations": {
+ "type": "array",
+ "example": [
+ "no-liability"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "body": {
+ "type": "string",
+ "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
+ },
+ "featured": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id",
+ "html_url",
+ "description",
+ "implementation",
+ "permissions",
+ "conditions",
+ "limitations",
+ "body",
+ "featured"
+ ]
+ },
+ "marketplace-listing-plan": {
+ "title": "Marketplace Listing Plan",
+ "description": "Marketplace Listing Plan",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/marketplace_listing/plans/1313"
+ },
+ "accounts_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/marketplace_listing/plans/1313/accounts"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1313
+ },
+ "number": {
+ "type": "integer",
+ "example": 3
+ },
+ "name": {
+ "type": "string",
+ "example": "Pro"
+ },
+ "description": {
+ "type": "string",
+ "example": "A professional-grade CI solution"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer",
+ "example": 1099
+ },
+ "yearly_price_in_cents": {
+ "type": "integer",
+ "example": 11870
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ],
+ "example": "FLAT_RATE"
+ },
+ "has_free_trial": {
+ "type": "boolean",
+ "example": true
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "state": {
+ "type": "string",
+ "example": "published"
+ },
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "Up to 25 private repositories",
+ "11 concurrent builds"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "accounts_url",
+ "id",
+ "number",
+ "name",
+ "description",
+ "has_free_trial",
+ "price_model",
+ "unit_name",
+ "monthly_price_in_cents",
+ "state",
+ "yearly_price_in_cents",
+ "bullets"
+ ]
+ },
+ "marketplace-purchase": {
+ "title": "Marketplace Purchase",
+ "description": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "marketplace_pending_change": {
+ "type": "object",
+ "properties": {
+ "is_installed": {
+ "type": "boolean"
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "unit_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "plan": {
+ "$ref": "#/components/schemas/marketplace-listing-plan"
+ }
+ },
+ "nullable": true
+ },
+ "marketplace_purchase": {
+ "type": "object",
+ "properties": {
+ "billing_cycle": {
+ "type": "string"
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "is_installed": {
+ "type": "boolean"
+ },
+ "unit_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "plan": {
+ "$ref": "#/components/schemas/marketplace-listing-plan"
+ }
+ }
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "type",
+ "login",
+ "marketplace_purchase"
+ ]
+ },
+ "api-overview": {
+ "title": "Api Overview",
+ "description": "Api Overview",
+ "type": "object",
+ "properties": {
+ "verifiable_password_authentication": {
+ "type": "boolean",
+ "example": true
+ },
+ "ssh_key_fingerprints": {
+ "type": "object",
+ "properties": {
+ "SHA256_RSA": {
+ "type": "string"
+ },
+ "SHA256_DSA": {
+ "type": "string"
+ },
+ "SHA256_ECDSA": {
+ "type": "string"
+ },
+ "SHA256_ED25519": {
+ "type": "string"
+ }
+ }
+ },
+ "ssh_keys": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+ ]
+ },
+ "hooks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "github_enterprise_importer": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "web": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "api": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "git": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "packages": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "pages": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "importer": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "actions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "dependabot": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "192.0.2.1"
+ ]
+ },
+ "domains": {
+ "type": "object",
+ "properties": {
+ "website": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "example.com"
+ ]
+ }
+ },
+ "codespaces": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "example.com"
+ ]
+ }
+ },
+ "copilot": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "example.com"
+ ]
+ }
+ },
+ "packages": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "example.com"
+ ]
+ }
+ },
+ "actions": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "example.com"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "verifiable_password_authentication"
+ ]
+ },
+ "security-and-analysis": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "advanced_security": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "dependabot_security_updates": {
+ "description": "Enable or disable Dependabot security updates for the repository.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The enablement status of Dependabot security updates for the repository.",
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "minimal-repository": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "$ref": "#/components/schemas/code-of-conduct"
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer",
+ "example": 0
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 0
+ },
+ "watchers": {
+ "type": "integer",
+ "example": 0
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "$ref": "#/components/schemas/security-and-analysis"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "thread": {
+ "title": "Thread",
+ "description": "Thread",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "subject": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "latest_comment_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "url",
+ "latest_comment_url",
+ "type"
+ ]
+ },
+ "reason": {
+ "type": "string"
+ },
+ "unread": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "last_read_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string",
+ "example": "https://api.github.com/notifications/threads/2/subscription"
+ }
+ },
+ "required": [
+ "id",
+ "unread",
+ "reason",
+ "updated_at",
+ "last_read_at",
+ "subject",
+ "repository",
+ "url",
+ "subscription_url"
+ ]
+ },
+ "thread-subscription": {
+ "title": "Thread Subscription",
+ "description": "Thread Subscription",
+ "type": "object",
+ "properties": {
+ "subscribed": {
+ "type": "boolean",
+ "example": true
+ },
+ "ignored": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-10-06T21:34:12Z",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/notifications/threads/1/subscription"
+ },
+ "thread_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/notifications/threads/1"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/1"
+ }
+ },
+ "required": [
+ "created_at",
+ "ignored",
+ "reason",
+ "url",
+ "subscribed"
+ ]
+ },
+ "organization-simple": {
+ "title": "Organization Simple",
+ "description": "A GitHub organization.",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
+ },
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
+ },
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
+ },
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description"
+ ]
+ },
+ "organization-full": {
+ "title": "Organization Full",
+ "description": "Organization Full",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
+ },
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
+ },
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
+ },
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "advanced_security_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "dependabot_alerts_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "dependabot_security_updates_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "dependency_graph_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "secret_scanning_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "secret_scanning_push_protection_enabled_for_new_repositories": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
+ },
+ "secret_scanning_push_protection_custom_link_enabled": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."
+ },
+ "secret_scanning_push_protection_custom_link": {
+ "type": "string",
+ "example": "https://github.com/test-org/test-repo/blob/main/README.md",
+ "nullable": true,
+ "description": "An optional URL string to display to contributors who are blocked from pushing a secret."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "actions-cache-usage-org-enterprise": {
+ "type": "object",
+ "properties": {
+ "total_active_caches_count": {
+ "type": "integer",
+ "description": "The count of active caches across all repositories of an enterprise or an organization."
+ },
+ "total_active_caches_size_in_bytes": {
+ "type": "integer",
+ "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization."
+ }
+ },
+ "required": [
+ "total_active_caches_count",
+ "total_active_caches_size_in_bytes"
+ ]
+ },
+ "actions-cache-usage-by-repository": {
+ "title": "Actions Cache Usage by repository",
+ "description": "GitHub Actions Cache Usage by repository.",
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "description": "The repository owner and name for the cache usage being shown.",
+ "type": "string",
+ "example": "octo-org/Hello-World"
+ },
+ "active_caches_size_in_bytes": {
+ "description": "The sum of the size in bytes of all the active cache items in the repository.",
+ "type": "integer",
+ "example": 2322142
+ },
+ "active_caches_count": {
+ "description": "The number of active caches in the repository.",
+ "type": "integer",
+ "example": 3
+ }
+ },
+ "required": [
+ "full_name",
+ "active_caches_size_in_bytes",
+ "active_caches_count"
+ ]
+ },
+ "oidc-custom-sub": {
+ "title": "Actions OIDC Subject customization",
+ "description": "Actions OIDC Subject customization",
+ "type": "object",
+ "properties": {
+ "include_claim_keys": {
+ "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "include_claim_keys"
+ ]
+ },
+ "empty-object": {
+ "title": "Empty Object",
+ "description": "An object without any properties.",
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ },
+ "enabled-repositories": {
+ "type": "string",
+ "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.",
+ "enum": [
+ "all",
+ "none",
+ "selected"
+ ]
+ },
+ "allowed-actions": {
+ "type": "string",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
+ "enum": [
+ "all",
+ "local_only",
+ "selected"
+ ]
+ },
+ "selected-actions-url": {
+ "type": "string",
+ "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`."
+ },
+ "actions-organization-permissions": {
+ "type": "object",
+ "properties": {
+ "enabled_repositories": {
+ "$ref": "#/components/schemas/enabled-repositories"
+ },
+ "selected_repositories_url": {
+ "type": "string",
+ "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`."
+ },
+ "allowed_actions": {
+ "$ref": "#/components/schemas/allowed-actions"
+ },
+ "selected_actions_url": {
+ "$ref": "#/components/schemas/selected-actions-url"
+ }
+ },
+ "required": [
+ "enabled_repositories"
+ ]
+ },
+ "selected-actions": {
+ "type": "object",
+ "properties": {
+ "github_owned_allowed": {
+ "type": "boolean",
+ "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
+ },
+ "verified_allowed": {
+ "type": "boolean",
+ "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators."
+ },
+ "patterns_allowed": {
+ "type": "array",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n**Note**: The `patterns_allowed` setting only applies to public repositories.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "actions-default-workflow-permissions": {
+ "type": "string",
+ "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "actions-can-approve-pull-request-reviews": {
+ "type": "boolean",
+ "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
+ },
+ "actions-get-default-workflow-permissions": {
+ "type": "object",
+ "properties": {
+ "default_workflow_permissions": {
+ "$ref": "#/components/schemas/actions-default-workflow-permissions"
+ },
+ "can_approve_pull_request_reviews": {
+ "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews"
+ }
+ },
+ "required": [
+ "default_workflow_permissions",
+ "can_approve_pull_request_reviews"
+ ]
+ },
+ "actions-set-default-workflow-permissions": {
+ "type": "object",
+ "properties": {
+ "default_workflow_permissions": {
+ "$ref": "#/components/schemas/actions-default-workflow-permissions"
+ },
+ "can_approve_pull_request_reviews": {
+ "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews"
+ }
+ }
+ },
+ "runner-label": {
+ "title": "Self hosted runner label",
+ "description": "A label for a self hosted runner",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique identifier of the label."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the label."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of label. Read-only labels are applied automatically when the runner is configured.",
+ "enum": [
+ "read-only",
+ "custom"
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "runner": {
+ "title": "Self hosted runners",
+ "description": "A self hosted runner",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the runner.",
+ "type": "integer",
+ "example": 5
+ },
+ "runner_group_id": {
+ "description": "The id of the runner group.",
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "description": "The name of the runner.",
+ "type": "string",
+ "example": "iMac"
+ },
+ "os": {
+ "description": "The Operating System of the runner.",
+ "type": "string",
+ "example": "macos"
+ },
+ "status": {
+ "description": "The status of the runner.",
+ "type": "string",
+ "example": "online"
+ },
+ "busy": {
+ "type": "boolean"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner-label"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "os",
+ "status",
+ "busy",
+ "labels"
+ ]
+ },
+ "runner-application": {
+ "title": "Runner Application",
+ "description": "Runner Application",
+ "type": "object",
+ "properties": {
+ "os": {
+ "type": "string"
+ },
+ "architecture": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string"
+ },
+ "filename": {
+ "type": "string"
+ },
+ "temp_download_token": {
+ "description": "A short lived bearer token used to download the runner, if needed.",
+ "type": "string"
+ },
+ "sha256_checksum": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "os",
+ "architecture",
+ "download_url",
+ "filename"
+ ]
+ },
+ "authentication-token": {
+ "title": "Authentication Token",
+ "description": "Authentication Token",
+ "type": "object",
+ "properties": {
+ "token": {
+ "description": "The token used for authentication",
+ "type": "string",
+ "example": "v1.1f699f1069f60xxx"
+ },
+ "expires_at": {
+ "description": "The time this token expires",
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-07-11T22:14:10Z"
+ },
+ "permissions": {
+ "type": "object",
+ "example": {
+ "issues": "read",
+ "deployments": "write"
+ }
+ },
+ "repositories": {
+ "description": "The repositories this token has access to",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "single_file": {
+ "type": "string",
+ "example": "config.yaml",
+ "nullable": true
+ },
+ "repository_selection": {
+ "description": "Describe whether all repositories have been selected or there's a selection involved",
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ }
+ },
+ "required": [
+ "token",
+ "expires_at"
+ ]
+ },
+ "organization-actions-secret": {
+ "title": "Actions Secret for an Organization",
+ "description": "Secrets for GitHub Actions for an organization.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret.",
+ "example": "SECRET_TOKEN",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "visibility": {
+ "description": "Visibility of a secret",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "selected_repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at",
+ "visibility"
+ ]
+ },
+ "actions-public-key": {
+ "title": "ActionsPublicKey",
+ "description": "The public key used for setting Actions Secrets.",
+ "type": "object",
+ "properties": {
+ "key_id": {
+ "description": "The identifier for the key.",
+ "type": "string",
+ "example": "1234567"
+ },
+ "key": {
+ "description": "The Base64 encoded public key.",
+ "type": "string",
+ "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
+ },
+ "id": {
+ "type": "integer",
+ "example": 2
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/user/keys/2"
+ },
+ "title": {
+ "type": "string",
+ "example": "ssh-rsa AAAAB3NzaC1yc2EAAA"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2011-01-26T19:01:12Z"
+ }
+ },
+ "required": [
+ "key_id",
+ "key"
+ ]
+ },
+ "organization-actions-variable": {
+ "title": "Actions Variable for an Organization",
+ "description": "Organization variable for GitHub Actions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the variable.",
+ "example": "USERNAME",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the variable.",
+ "example": "octocat",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "example": "2019-01-24T22:45:36.000Z",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "example": "2019-01-24T22:45:36.000Z",
+ "type": "string",
+ "format": "date-time"
+ },
+ "visibility": {
+ "description": "Visibility of a variable",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "selected_repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories"
+ }
+ },
+ "required": [
+ "name",
+ "value",
+ "created_at",
+ "updated_at",
+ "visibility"
+ ]
+ },
+ "code-scanning-analysis-tool-name": {
+ "type": "string",
+ "description": "The name of the tool used to generate the code scanning analysis."
+ },
+ "code-scanning-analysis-tool-guid": {
+ "nullable": true,
+ "type": "string",
+ "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
+ },
+ "code-scanning-alert-state-query": {
+ "type": "string",
+ "description": "State of a code scanning alert.",
+ "enum": [
+ "open",
+ "closed",
+ "dismissed",
+ "fixed"
+ ]
+ },
+ "code-scanning-alert-severity": {
+ "type": "string",
+ "description": "Severity of a code scanning alert.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "warning",
+ "note",
+ "error"
+ ]
+ },
+ "alert-instances-url": {
+ "type": "string",
+ "description": "The REST API URL for fetching the list of instances for an alert.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "code-scanning-alert-state": {
+ "type": "string",
+ "description": "State of a code scanning alert.",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ },
+ "code-scanning-alert-dismissed-reason": {
+ "type": "string",
+ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.",
+ "nullable": true,
+ "enum": [
+ null,
+ "false positive",
+ "won't fix",
+ "used in tests"
+ ]
+ },
+ "code-scanning-alert-dismissed-comment": {
+ "type": "string",
+ "description": "The dismissal comment associated with the dismissal of the alert.",
+ "nullable": true,
+ "maxLength": 280
+ },
+ "code-scanning-alert-rule-summary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "nullable": true,
+ "type": "string",
+ "description": "A unique identifier for the rule used to detect the alert."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the rule used to detect the alert."
+ },
+ "tags": {
+ "nullable": true,
+ "type": "array",
+ "description": "A set of tags applicable for the rule.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "severity": {
+ "nullable": true,
+ "type": "string",
+ "description": "The severity of the alert.",
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error"
+ ]
+ },
+ "security_severity_level": {
+ "nullable": true,
+ "type": "string",
+ "description": "The security severity of the alert.",
+ "enum": [
+ "low",
+ "medium",
+ "high",
+ "critical"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the rule used to detect the alert."
+ }
+ }
+ },
+ "code-scanning-analysis-tool-version": {
+ "nullable": true,
+ "type": "string",
+ "description": "The version of the tool used to generate the code scanning analysis."
+ },
+ "code-scanning-analysis-tool": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-name"
+ },
+ "version": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-version"
+ },
+ "guid": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
+ }
+ }
+ },
+ "code-scanning-ref": {
+ "type": "string",
+ "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``."
+ },
+ "code-scanning-analysis-analysis-key": {
+ "type": "string",
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
+ },
+ "code-scanning-alert-environment": {
+ "type": "string",
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
+ },
+ "code-scanning-analysis-category": {
+ "type": "string",
+ "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
+ },
+ "code-scanning-alert-location": {
+ "type": "object",
+ "description": "Describe a region within a file for the alert.",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "start_line": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "end_column": {
+ "type": "integer"
+ }
+ }
+ },
+ "code-scanning-alert-classification": {
+ "type": "string",
+ "description": "A classification of the file. For example to identify it as generated.",
+ "nullable": true,
+ "enum": [
+ "source",
+ "generated",
+ "test",
+ "library"
+ ]
+ },
+ "code-scanning-alert-instance": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "$ref": "#/components/schemas/code-scanning-ref"
+ },
+ "analysis_key": {
+ "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
+ },
+ "environment": {
+ "$ref": "#/components/schemas/code-scanning-alert-environment"
+ },
+ "category": {
+ "$ref": "#/components/schemas/code-scanning-analysis-category"
+ },
+ "state": {
+ "$ref": "#/components/schemas/code-scanning-alert-state"
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "location": {
+ "$ref": "#/components/schemas/code-scanning-alert-location"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.",
+ "items": {
+ "$ref": "#/components/schemas/code-scanning-alert-classification"
+ }
+ }
+ }
+ },
+ "code-scanning-organization-alert-items": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "instances_url": {
+ "$ref": "#/components/schemas/alert-instances-url"
+ },
+ "state": {
+ "$ref": "#/components/schemas/code-scanning-alert-state"
+ },
+ "fixed_at": {
+ "$ref": "#/components/schemas/alert-fixed-at"
+ },
+ "dismissed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "dismissed_at": {
+ "$ref": "#/components/schemas/alert-dismissed-at"
+ },
+ "dismissed_reason": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
+ },
+ "dismissed_comment": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
+ },
+ "rule": {
+ "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
+ },
+ "tool": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
+ },
+ "most_recent_instance": {
+ "$ref": "#/components/schemas/code-scanning-alert-instance"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/simple-repository"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "instances_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool",
+ "most_recent_instance",
+ "repository"
+ ]
+ },
+ "nullable-codespace-machine": {
+ "type": "object",
+ "title": "Codespace machine",
+ "description": "A description of the machine powering a codespace.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the machine.",
+ "example": "standardLinux"
+ },
+ "display_name": {
+ "type": "string",
+ "description": "The display name of the machine includes cores, memory, and storage.",
+ "example": "4 cores, 16 GB RAM, 64 GB storage"
+ },
+ "operating_system": {
+ "type": "string",
+ "description": "The operating system of the machine.",
+ "example": "linux"
+ },
+ "storage_in_bytes": {
+ "type": "integer",
+ "description": "How much storage is available to the codespace.",
+ "example": 68719476736
+ },
+ "memory_in_bytes": {
+ "type": "integer",
+ "description": "How much memory is available to the codespace.",
+ "example": 17179869184
+ },
+ "cpus": {
+ "type": "integer",
+ "description": "How many cores are available to the codespace.",
+ "example": 4
+ },
+ "prebuild_availability": {
+ "type": "string",
+ "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.",
+ "example": "ready",
+ "enum": [
+ "none",
+ "ready",
+ "in_progress"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "display_name",
+ "operating_system",
+ "storage_in_bytes",
+ "memory_in_bytes",
+ "cpus",
+ "prebuild_availability"
+ ],
+ "nullable": true
+ },
+ "codespace": {
+ "type": "object",
+ "title": "Codespace",
+ "description": "A codespace.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "description": "Automatically generated name of this codespace.",
+ "type": "string",
+ "example": "monalisa-octocat-hello-world-g4wpq6h95q"
+ },
+ "display_name": {
+ "description": "Display name for this codespace.",
+ "type": "string",
+ "example": "bookish space pancake",
+ "nullable": true
+ },
+ "environment_id": {
+ "description": "UUID identifying this codespace's environment.",
+ "type": "string",
+ "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "nullable": true
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "billable_owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "machine": {
+ "$ref": "#/components/schemas/nullable-codespace-machine"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json from repo root used to create Codespace.",
+ "type": "string",
+ "example": ".devcontainer/example/devcontainer.json",
+ "nullable": true
+ },
+ "prebuild": {
+ "description": "Whether the codespace was created from a prebuild.",
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "last_used_at": {
+ "description": "Last known time this codespace was started.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "state": {
+ "description": "State of this codespace.",
+ "enum": [
+ "Unknown",
+ "Created",
+ "Queued",
+ "Provisioning",
+ "Available",
+ "Awaiting",
+ "Unavailable",
+ "Deleted",
+ "Moved",
+ "Shutdown",
+ "Archived",
+ "Starting",
+ "ShuttingDown",
+ "Failed",
+ "Exporting",
+ "Updating",
+ "Rebuilding"
+ ],
+ "example": "Available",
+ "type": "string"
+ },
+ "url": {
+ "description": "API URL for this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "git_status": {
+ "description": "Details about the codespace's git repository.",
+ "type": "object",
+ "properties": {
+ "ahead": {
+ "description": "The number of commits the local repository is ahead of the remote.",
+ "type": "integer",
+ "example": 0
+ },
+ "behind": {
+ "description": "The number of commits the local repository is behind the remote.",
+ "type": "integer",
+ "example": 0
+ },
+ "has_unpushed_changes": {
+ "description": "Whether the local repository has unpushed changes.",
+ "type": "boolean"
+ },
+ "has_uncommitted_changes": {
+ "description": "Whether the local repository has uncommitted changes.",
+ "type": "boolean"
+ },
+ "ref": {
+ "description": "The current branch (or SHA if in detached HEAD state) of the local repository.",
+ "type": "string",
+ "example": "main"
+ }
+ }
+ },
+ "location": {
+ "description": "The initally assigned location of a new codespace.",
+ "enum": [
+ "EastUs",
+ "SouthEastAsia",
+ "WestEurope",
+ "WestUs2"
+ ],
+ "example": "WestUs2",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.",
+ "type": "integer",
+ "example": 60,
+ "nullable": true
+ },
+ "web_url": {
+ "description": "URL to access this codespace on the web.",
+ "type": "string",
+ "format": "uri"
+ },
+ "machines_url": {
+ "description": "API URL to access available alternate machine types for this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "start_url": {
+ "description": "API URL to start this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "stop_url": {
+ "description": "API URL to stop this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "publish_url": {
+ "description": "API URL to publish this codespace to a new repository.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "pulls_url": {
+ "description": "API URL for the Pull Request associated with this codespace, if any.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "recent_folders": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "runtime_constraints": {
+ "type": "object",
+ "properties": {
+ "allowed_port_privacy_settings": {
+ "description": "The privacy settings a user can select from when forwarding a port.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "pending_operation": {
+ "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.",
+ "type": "boolean",
+ "nullable": true
+ },
+ "pending_operation_disabled_reason": {
+ "description": "Text to show user when codespace is disabled by a pending operation",
+ "type": "string",
+ "nullable": true
+ },
+ "idle_timeout_notice": {
+ "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
+ "type": "string",
+ "nullable": true
+ },
+ "retention_period_minutes": {
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
+ "type": "integer",
+ "example": 60,
+ "nullable": true
+ },
+ "retention_expires_at": {
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T20:01:12Z",
+ "nullable": true
+ },
+ "last_known_stop_notice": {
+ "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.",
+ "type": "string",
+ "example": "you've used 100% of your spending limit for Codespaces",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "environment_id",
+ "owner",
+ "billable_owner",
+ "repository",
+ "machine",
+ "prebuild",
+ "created_at",
+ "updated_at",
+ "last_used_at",
+ "state",
+ "url",
+ "git_status",
+ "location",
+ "idle_timeout_minutes",
+ "web_url",
+ "machines_url",
+ "start_url",
+ "stop_url",
+ "pulls_url",
+ "recent_folders"
+ ]
+ },
+ "codespaces-org-secret": {
+ "title": "Codespaces Secret",
+ "description": "Secrets for a GitHub Codespace.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret",
+ "example": "SECRET_NAME",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "visibility": {
+ "description": "The type of repositories in the organization that the secret is visible to",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "selected_repositories_url": {
+ "description": "The API URL at which the list of repositories this secret is visible to can be retrieved",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at",
+ "visibility"
+ ]
+ },
+ "codespaces-public-key": {
+ "title": "CodespacesPublicKey",
+ "description": "The public key used for setting Codespaces secrets.",
+ "type": "object",
+ "properties": {
+ "key_id": {
+ "description": "The identifier for the key.",
+ "type": "string",
+ "example": "1234567"
+ },
+ "key": {
+ "description": "The Base64 encoded public key.",
+ "type": "string",
+ "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
+ },
+ "id": {
+ "type": "integer",
+ "example": 2
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/user/keys/2"
+ },
+ "title": {
+ "type": "string",
+ "example": "ssh-rsa AAAAB3NzaC1yc2EAAA"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2011-01-26T19:01:12Z"
+ }
+ },
+ "required": [
+ "key_id",
+ "key"
+ ]
+ },
+ "copilot-seat-breakdown": {
+ "title": "Copilot Business Seat Breakdown",
+ "description": "The breakdown of Copilot Business seats for the organization.",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "The total number of seats being billed for the organization as of the current billing cycle."
+ },
+ "added_this_cycle": {
+ "type": "integer",
+ "description": "Seats added during the current billing cycle."
+ },
+ "pending_cancellation": {
+ "type": "integer",
+ "description": "The number of seats that are pending cancellation at the end of the current billing cycle."
+ },
+ "pending_invitation": {
+ "type": "integer",
+ "description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
+ },
+ "active_this_cycle": {
+ "type": "integer",
+ "description": "The number of seats that have used Copilot during the current billing cycle."
+ },
+ "inactive_this_cycle": {
+ "type": "integer",
+ "description": "The number of seats that have not used Copilot during the current billing cycle."
+ }
+ }
+ },
+ "copilot-organization-details": {
+ "title": "Copilot Business Organization Details",
+ "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business subscription.",
+ "type": "object",
+ "properties": {
+ "seat_breakdown": {
+ "$ref": "#/components/schemas/copilot-seat-breakdown"
+ },
+ "public_code_suggestions": {
+ "type": "string",
+ "description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
+ "enum": [
+ "allow",
+ "block",
+ "unconfigured",
+ "unknown"
+ ]
+ },
+ "ide_chat": {
+ "type": "string",
+ "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
+ "enum": [
+ "enabled",
+ "disabled",
+ "unconfigured"
+ ]
+ },
+ "platform_chat": {
+ "type": "string",
+ "description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
+ "enum": [
+ "enabled",
+ "disabled",
+ "unconfigured"
+ ]
+ },
+ "cli": {
+ "type": "string",
+ "description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
+ "enum": [
+ "enabled",
+ "disabled",
+ "unconfigured"
+ ]
+ },
+ "seat_management_setting": {
+ "type": "string",
+ "description": "The mode of assigning new seats.",
+ "enum": [
+ "assign_all",
+ "assign_selected",
+ "disabled",
+ "unconfigured"
+ ]
+ }
+ },
+ "required": [
+ "seat_breakdown",
+ "public_code_suggestions",
+ "seat_management_setting"
+ ],
+ "additionalProperties": true
+ },
+ "nullable-team-simple": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/nullable-team-simple"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ },
+ "organization": {
+ "title": "Organization",
+ "description": "GitHub account for managing multiple users, teams, and repositories",
+ "type": "object",
+ "properties": {
+ "login": {
+ "description": "Unique login name of the organization",
+ "example": "new-org",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the organization",
+ "example": "https://api.github.com/orgs/github",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "public_members_url": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "blog": {
+ "description": "Display blog url for the organization",
+ "example": "blog.example-org.com",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "description": "Display name for the organization",
+ "example": "New Org",
+ "type": "string"
+ },
+ "company": {
+ "description": "Display company name for the organization",
+ "example": "Acme corporation",
+ "type": "string"
+ },
+ "location": {
+ "description": "Display location for the organization",
+ "example": "Berlin, Germany",
+ "type": "string"
+ },
+ "email": {
+ "description": "Display email for the organization",
+ "example": "org@example.com",
+ "type": "string",
+ "format": "email"
+ },
+ "has_organization_projects": {
+ "description": "Specifies if organization projects are enabled for this org",
+ "type": "boolean"
+ },
+ "has_repository_projects": {
+ "description": "Specifies if repository projects are enabled for repositories that belong to this org",
+ "type": "boolean"
+ },
+ "is_verified": {
+ "type": "boolean"
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "copilot-seat-details": {
+ "title": "Copilot Business Seat Detail",
+ "description": "Information about a Copilot Business seat assignment for a user, team, or organization.",
+ "type": "object",
+ "properties": {
+ "assignee": {
+ "type": "object",
+ "description": "The assignee that has been granted access to GitHub Copilot.",
+ "additionalProperties": true,
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ {
+ "$ref": "#/components/schemas/team"
+ },
+ {
+ "$ref": "#/components/schemas/organization"
+ }
+ ]
+ },
+ "assigning_team": {
+ "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/team"
+ }
+ ],
+ "nullable": true
+ },
+ "pending_cancellation_date": {
+ "type": "string",
+ "format": "date",
+ "nullable": true,
+ "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle."
+ },
+ "last_activity_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format."
+ },
+ "last_activity_editor": {
+ "type": "string",
+ "nullable": true,
+ "description": "Last editor that was used by the user for a GitHub Copilot completion."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format."
+ }
+ },
+ "required": [
+ "assignee",
+ "created_at"
+ ],
+ "additionalProperties": false
+ },
+ "organization-dependabot-secret": {
+ "title": "Dependabot Secret for an Organization",
+ "description": "Secrets for GitHub Dependabot for an organization.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret.",
+ "example": "SECRET_TOKEN",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "visibility": {
+ "description": "Visibility of a secret",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "selected_repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at",
+ "visibility"
+ ]
+ },
+ "dependabot-public-key": {
+ "title": "DependabotPublicKey",
+ "description": "The public key used for setting Dependabot Secrets.",
+ "type": "object",
+ "properties": {
+ "key_id": {
+ "description": "The identifier for the key.",
+ "type": "string",
+ "example": "1234567"
+ },
+ "key": {
+ "description": "The Base64 encoded public key.",
+ "type": "string",
+ "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
+ }
+ },
+ "required": [
+ "key_id",
+ "key"
+ ]
+ },
+ "nullable-minimal-repository": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "$ref": "#/components/schemas/code-of-conduct"
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer",
+ "example": 0
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 0
+ },
+ "watchers": {
+ "type": "integer",
+ "example": 0
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "$ref": "#/components/schemas/security-and-analysis"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ],
+ "nullable": true
+ },
+ "package": {
+ "title": "Package",
+ "description": "A software package",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the package.",
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "description": "The name of the package.",
+ "type": "string",
+ "example": "super-linter"
+ },
+ "package_type": {
+ "type": "string",
+ "example": "docker",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/packages/container/super-linter"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/orgs/github/packages/container/package/super-linter"
+ },
+ "version_count": {
+ "description": "The number of versions of the package.",
+ "type": "integer",
+ "example": 1
+ },
+ "visibility": {
+ "type": "string",
+ "example": "private",
+ "enum": [
+ "private",
+ "public"
+ ]
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/nullable-minimal-repository"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "package_type",
+ "visibility",
+ "url",
+ "html_url",
+ "version_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "organization-invitation": {
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "team_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ },
+ "invitation_source": {
+ "type": "string",
+ "example": "\"member\""
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "email",
+ "role",
+ "created_at",
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
+ ]
+ },
+ "org-hook": {
+ "title": "Org Hook",
+ "description": "Org Hook",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octocat/hooks/1"
+ },
+ "ping_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octocat/hooks/1/pings"
+ },
+ "deliveries_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries"
+ },
+ "name": {
+ "type": "string",
+ "example": "web"
+ },
+ "events": {
+ "type": "array",
+ "example": [
+ "push",
+ "pull_request"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "active": {
+ "type": "boolean",
+ "example": true
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "example": "\"http://example.com/2\""
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "example": "\"0\""
+ },
+ "content_type": {
+ "type": "string",
+ "example": "\"form\""
+ },
+ "secret": {
+ "type": "string",
+ "example": "\"********\""
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-09-06T20:39:23Z"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-09-06T17:26:27Z"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "interaction-group": {
+ "type": "string",
+ "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.",
+ "example": "collaborators_only",
+ "enum": [
+ "existing_users",
+ "contributors_only",
+ "collaborators_only"
+ ]
+ },
+ "interaction-limit-response": {
+ "title": "Interaction Limits",
+ "description": "Interaction limit settings.",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "$ref": "#/components/schemas/interaction-group"
+ },
+ "origin": {
+ "type": "string",
+ "example": "repository"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-08-17T04:18:39Z"
+ }
+ },
+ "required": [
+ "limit",
+ "origin",
+ "expires_at"
+ ]
+ },
+ "interaction-expiry": {
+ "type": "string",
+ "description": "The duration of the interaction restriction. Default: `one_day`.",
+ "example": "one_month",
+ "enum": [
+ "one_day",
+ "three_days",
+ "one_week",
+ "one_month",
+ "six_months"
+ ]
+ },
+ "interaction-limit": {
+ "title": "Interaction Restrictions",
+ "description": "Limit interactions to a specific type of user for a specified duration",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "$ref": "#/components/schemas/interaction-group"
+ },
+ "expiry": {
+ "$ref": "#/components/schemas/interaction-expiry"
+ }
+ },
+ "required": [
+ "limit"
+ ]
+ },
+ "org-membership": {
+ "title": "Org Membership",
+ "description": "Org Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octocat/memberships/defunkt"
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.",
+ "example": "active",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ },
+ "role": {
+ "type": "string",
+ "description": "The user's membership type in the organization.",
+ "example": "admin",
+ "enum": [
+ "admin",
+ "member",
+ "billing_manager"
+ ]
+ },
+ "organization_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octocat"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ },
+ "migration": {
+ "title": "Migration",
+ "description": "A migration.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 79
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "guid": {
+ "type": "string",
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516"
+ },
+ "state": {
+ "type": "string",
+ "example": "pending"
+ },
+ "lock_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "exclude_metadata": {
+ "type": "boolean"
+ },
+ "exclude_git_data": {
+ "type": "boolean"
+ },
+ "exclude_attachments": {
+ "type": "boolean"
+ },
+ "exclude_releases": {
+ "type": "boolean"
+ },
+ "exclude_owner_projects": {
+ "type": "boolean"
+ },
+ "org_metadata_only": {
+ "type": "boolean"
+ },
+ "repositories": {
+ "type": "array",
+ "description": "The repositories included in the migration. Only returned for export migrations.",
+ "items": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/octo-org/migrations/79"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2015-07-06T15:33:38-07:00"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2015-07-06T15:33:38-07:00"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "exclude": {
+ "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
+ "type": "array",
+ "items": {
+ "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.",
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "guid",
+ "state",
+ "lock_repositories",
+ "exclude_metadata",
+ "exclude_git_data",
+ "exclude_attachments",
+ "exclude_releases",
+ "exclude_owner_projects",
+ "org_metadata_only",
+ "repositories",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "organization-fine-grained-permission": {
+ "title": "Organization Fine-Grained Permission",
+ "description": "A fine-grained permission that protects organization resources.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "description"
+ ]
+ },
+ "organization-role": {
+ "title": "Organization Role",
+ "description": "Organization roles",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The unique identifier of the role.",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the role.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A short description about who this role is for or what permissions it grants.",
+ "type": "string",
+ "nullable": true
+ },
+ "permissions": {
+ "description": "A list of permissions included in this role.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "organization": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "description": "The date and time the role was created.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "description": "The date and time the role was last updated.",
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "permissions",
+ "organization",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "package-version": {
+ "title": "Package Version",
+ "description": "A version of a software package",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the package version.",
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "description": "The name of the package version.",
+ "type": "string",
+ "example": "latest"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068"
+ },
+ "package_html_url": {
+ "type": "string",
+ "example": "https://github.com/orgs/github/packages/container/package/super-linter"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/orgs/github/packages/container/super-linter/786068"
+ },
+ "license": {
+ "type": "string",
+ "example": "MIT"
+ },
+ "description": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-10T20:09:31Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2014-03-03T18:58:10Z"
+ },
+ "deleted_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2014-03-03T18:58:10Z"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "Package Version Metadata",
+ "properties": {
+ "package_type": {
+ "type": "string",
+ "example": "docker",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ },
+ "container": {
+ "type": "object",
+ "title": "Container Metadata",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "tags"
+ ]
+ },
+ "docker": {
+ "type": "object",
+ "title": "Docker Metadata",
+ "properties": {
+ "tag": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "tags"
+ ]
+ }
+ },
+ "required": [
+ "package_type"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url",
+ "package_html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "organization-programmatic-access-grant-request": {
+ "title": "Simple Organization Programmatic Access Grant Request",
+ "description": "Minimal representation of an organization programmatic access grant request for enumerations",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests."
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true,
+ "description": "Reason for requesting access."
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "repository_selection": {
+ "type": "string",
+ "enum": [
+ "none",
+ "all",
+ "subset"
+ ],
+ "description": "Type of repository selection requested."
+ },
+ "repositories_url": {
+ "type": "string",
+ "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`."
+ },
+ "permissions": {
+ "type": "object",
+ "description": "Permissions requested, categorized by type of permission.",
+ "properties": {
+ "organization": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repository": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "other": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "description": "Date and time when the request for access was created."
+ },
+ "token_expired": {
+ "type": "boolean",
+ "description": "Whether the associated fine-grained personal access token has expired."
+ },
+ "token_expires_at": {
+ "type": "string",
+ "nullable": true,
+ "description": "Date and time when the associated fine-grained personal access token expires."
+ },
+ "token_last_used_at": {
+ "type": "string",
+ "nullable": true,
+ "description": "Date and time when the associated fine-grained personal access token was last used for authentication."
+ }
+ },
+ "required": [
+ "id",
+ "reason",
+ "owner",
+ "repository_selection",
+ "repositories_url",
+ "permissions",
+ "created_at",
+ "token_expired",
+ "token_expires_at",
+ "token_last_used_at"
+ ]
+ },
+ "organization-programmatic-access-grant": {
+ "title": "Organization Programmatic Access Grant",
+ "description": "Minimal representation of an organization programmatic access grant for enumerations",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token."
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "repository_selection": {
+ "type": "string",
+ "enum": [
+ "none",
+ "all",
+ "subset"
+ ],
+ "description": "Type of repository selection requested."
+ },
+ "repositories_url": {
+ "type": "string",
+ "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`."
+ },
+ "permissions": {
+ "type": "object",
+ "description": "Permissions requested, categorized by type of permission.",
+ "properties": {
+ "organization": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repository": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "other": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "access_granted_at": {
+ "type": "string",
+ "description": "Date and time when the fine-grained personal access token was approved to access the organization."
+ },
+ "token_expired": {
+ "type": "boolean",
+ "description": "Whether the associated fine-grained personal access token has expired."
+ },
+ "token_expires_at": {
+ "type": "string",
+ "nullable": true,
+ "description": "Date and time when the associated fine-grained personal access token expires."
+ },
+ "token_last_used_at": {
+ "type": "string",
+ "nullable": true,
+ "description": "Date and time when the associated fine-grained personal access token was last used for authentication."
+ }
+ },
+ "required": [
+ "id",
+ "owner",
+ "repository_selection",
+ "repositories_url",
+ "permissions",
+ "access_granted_at",
+ "token_expired",
+ "token_expires_at",
+ "token_last_used_at"
+ ]
+ },
+ "project": {
+ "title": "Project",
+ "description": "Projects are a way to organize columns and cards of work.",
+ "type": "object",
+ "properties": {
+ "owner_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/api-playground/projects-test"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/1002604"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/api-playground/projects-test/projects/12"
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/1002604/columns"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1002604
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6UHJvamVjdDEwMDI2MDQ="
+ },
+ "name": {
+ "description": "Name of the project",
+ "example": "Week One Sprint",
+ "type": "string"
+ },
+ "body": {
+ "description": "Body of the project",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer",
+ "example": 1
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "example": "open",
+ "type": "string"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-10T20:09:31Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2014-03-03T18:58:10Z"
+ },
+ "organization_permission": {
+ "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.",
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ]
+ },
+ "private": {
+ "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "number",
+ "name",
+ "body",
+ "state",
+ "url",
+ "html_url",
+ "owner_url",
+ "creator",
+ "columns_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "org-custom-property": {
+ "title": "Organization Custom Property",
+ "description": "Custom property defined on an organization",
+ "type": "object",
+ "properties": {
+ "property_name": {
+ "type": "string",
+ "description": "The name of the property"
+ },
+ "value_type": {
+ "type": "string",
+ "example": "single_select",
+ "enum": [
+ "string",
+ "single_select"
+ ],
+ "description": "The type of the value for the property"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Whether the property is required."
+ },
+ "default_value": {
+ "type": "string",
+ "nullable": true,
+ "description": "Default value of the property"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true,
+ "description": "Short description of the property"
+ },
+ "allowed_values": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 75
+ },
+ "maxItems": 200,
+ "nullable": true,
+ "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
+ },
+ "values_editable_by": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "org_actors",
+ "org_and_repo_actors"
+ ],
+ "example": "org_actors",
+ "description": "Who can edit the values of the property"
+ }
+ },
+ "required": [
+ "property_name",
+ "value_type"
+ ]
+ },
+ "custom-property-value": {
+ "title": "Custom Property Value",
+ "description": "Custom property name and associated value",
+ "type": "object",
+ "properties": {
+ "property_name": {
+ "type": "string",
+ "description": "The name of the property"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ],
+ "description": "The value assigned to the property",
+ "nullable": true
+ }
+ },
+ "required": [
+ "property_name",
+ "value"
+ ]
+ },
+ "org-repo-custom-property-values": {
+ "title": "Organization Repository Custom Property Values",
+ "description": "List of custom property values for a repository",
+ "type": "object",
+ "properties": {
+ "repository_id": {
+ "type": "integer",
+ "example": 1296269
+ },
+ "repository_name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "repository_full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "properties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ },
+ "description": "List of custom property names and associated values"
+ }
+ },
+ "required": [
+ "repository_id",
+ "repository_name",
+ "repository_full_name",
+ "properties"
+ ]
+ },
+ "nullable-repository": {
+ "title": "Repository",
+ "description": "A repository on GitHub.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "deprecated": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_update_branch": {
+ "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:42Z\""
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean",
+ "description": "Whether anonymous git access is enabled for this repository"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ],
+ "nullable": true
+ },
+ "code-of-conduct-simple": {
+ "title": "Code Of Conduct Simple",
+ "description": "Code of Conduct Simple",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/github/docs/community/code_of_conduct"
+ },
+ "key": {
+ "type": "string",
+ "example": "citizen_code_of_conduct"
+ },
+ "name": {
+ "type": "string",
+ "example": "Citizen Code of Conduct"
+ },
+ "html_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md"
+ }
+ },
+ "required": [
+ "url",
+ "key",
+ "name",
+ "html_url"
+ ]
+ },
+ "full-repository": {
+ "title": "Full Repository",
+ "description": "Full Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "octocat",
+ "atom",
+ "electron",
+ "API"
+ ]
+ },
+ "has_issues": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "type": "string",
+ "example": "public"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "allow_rebase_merge": {
+ "type": "boolean",
+ "example": true
+ },
+ "template_repository": {
+ "$ref": "#/components/schemas/nullable-repository"
+ },
+ "temp_clone_token": {
+ "type": "string",
+ "nullable": true
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "example": true
+ },
+ "allow_update_branch": {
+ "type": "boolean",
+ "example": true
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "example": false
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "example": "PR_TITLE",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "example": "PR_BODY",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "example": "PR_TITLE",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "example": "PR_BODY",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_forking": {
+ "type": "boolean",
+ "example": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer",
+ "example": 42
+ },
+ "network_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "source": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "description": "Whether anonymous git access is allowed.",
+ "default": true,
+ "type": "boolean"
+ },
+ "code_of_conduct": {
+ "$ref": "#/components/schemas/code-of-conduct-simple"
+ },
+ "security_and_analysis": {
+ "$ref": "#/components/schemas/security-and-analysis"
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at",
+ "network_count",
+ "subscribers_count"
+ ]
+ },
+ "repository-rule-enforcement": {
+ "type": "string",
+ "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).",
+ "enum": [
+ "disabled",
+ "active",
+ "evaluate"
+ ]
+ },
+ "repository-ruleset-bypass-actor": {
+ "title": "Repository Ruleset Bypass Actor",
+ "type": "object",
+ "description": "An actor that can bypass rules in a ruleset",
+ "required": [
+ "actor_id",
+ "actor_type",
+ "bypass_mode"
+ ],
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`."
+ },
+ "actor_type": {
+ "type": "string",
+ "enum": [
+ "RepositoryRole",
+ "Team",
+ "Integration",
+ "OrganizationAdmin"
+ ],
+ "description": "The type of actor that can bypass a ruleset"
+ },
+ "bypass_mode": {
+ "type": "string",
+ "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.",
+ "enum": [
+ "always",
+ "pull_request"
+ ]
+ }
+ }
+ },
+ "repository-ruleset-conditions": {
+ "title": "Repository ruleset conditions for ref names",
+ "type": "object",
+ "description": "Parameters for a repository ruleset ref name condition",
+ "properties": {
+ "ref_name": {
+ "type": "object",
+ "properties": {
+ "include": {
+ "type": "array",
+ "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "exclude": {
+ "type": "array",
+ "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "repository-ruleset-conditions-repository-name-target": {
+ "title": "Repository ruleset conditions for repository names",
+ "type": "object",
+ "description": "Parameters for a repository name condition",
+ "properties": {
+ "repository_name": {
+ "type": "object",
+ "properties": {
+ "include": {
+ "type": "array",
+ "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "exclude": {
+ "type": "array",
+ "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "protected": {
+ "type": "boolean",
+ "description": "Whether renaming of target repositories is prevented."
+ }
+ }
+ }
+ },
+ "required": [
+ "repository_name"
+ ]
+ },
+ "repository-ruleset-conditions-repository-id-target": {
+ "title": "Repository ruleset conditions for repository IDs",
+ "type": "object",
+ "description": "Parameters for a repository ID condition",
+ "properties": {
+ "repository_id": {
+ "type": "object",
+ "properties": {
+ "repository_ids": {
+ "type": "array",
+ "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "repository_id"
+ ]
+ },
+ "repository-ruleset-conditions-repository-property-spec": {
+ "title": "Repository ruleset property targeting definition",
+ "type": "object",
+ "description": "Parameters for a targeting a repository property",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the repository property to target"
+ },
+ "property_values": {
+ "type": "array",
+ "description": "The values to match for the repository property",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "property_values"
+ ]
+ },
+ "repository-ruleset-conditions-repository-property-target": {
+ "title": "Repository ruleset conditions for repository properties",
+ "type": "object",
+ "description": "Parameters for a repository property condition",
+ "properties": {
+ "repository_property": {
+ "type": "object",
+ "properties": {
+ "include": {
+ "type": "array",
+ "description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+ }
+ },
+ "exclude": {
+ "type": "array",
+ "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "repository_property"
+ ]
+ },
+ "org-ruleset-conditions": {
+ "title": "Organization ruleset conditions",
+ "type": "object",
+ "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n",
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "repository_name_and_ref_name",
+ "description": "Conditions to target repositories by name and refs by name",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target"
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "title": "repository_id_and_ref_name",
+ "description": "Conditions to target repositories by id and refs by name",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "title": "repository_property_and_ref_name",
+ "description": "Conditions to target repositories by property and refs by name",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
+ }
+ ]
+ }
+ ]
+ },
+ "repository-rule-creation": {
+ "title": "creation",
+ "description": "Only allow users with bypass permission to create matching refs.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "creation"
+ ]
+ }
+ }
+ },
+ "repository-rule-update": {
+ "title": "update",
+ "description": "Only allow users with bypass permission to update matching refs.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "update"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "update_allows_fetch_and_merge": {
+ "type": "boolean",
+ "description": "Branch can pull changes from its upstream repository"
+ }
+ },
+ "required": [
+ "update_allows_fetch_and_merge"
+ ]
+ }
+ }
+ },
+ "repository-rule-deletion": {
+ "title": "deletion",
+ "description": "Only allow users with bypass permissions to delete matching refs.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "deletion"
+ ]
+ }
+ }
+ },
+ "repository-rule-required-linear-history": {
+ "title": "required_linear_history",
+ "description": "Prevent merge commits from being pushed to matching refs.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "required_linear_history"
+ ]
+ }
+ }
+ },
+ "repository-rule-required-deployments": {
+ "title": "required_deployments",
+ "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "required_deployments"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "required_deployment_environments": {
+ "type": "array",
+ "description": "The environments that must be successfully deployed to before branches can be merged.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "required_deployment_environments"
+ ]
+ }
+ }
+ },
+ "repository-rule-required-signatures": {
+ "title": "required_signatures",
+ "description": "Commits pushed to matching refs must have verified signatures.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "required_signatures"
+ ]
+ }
+ }
+ },
+ "repository-rule-pull-request": {
+ "title": "pull_request",
+ "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "pull_request"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "dismiss_stale_reviews_on_push": {
+ "type": "boolean",
+ "description": "New, reviewable commits pushed will dismiss previous pull request review approvals."
+ },
+ "require_code_owner_review": {
+ "type": "boolean",
+ "description": "Require an approving review in pull requests that modify files that have a designated code owner."
+ },
+ "require_last_push_approval": {
+ "type": "boolean",
+ "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it."
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "The number of approving reviews that are required before a pull request can be merged.",
+ "minimum": 0,
+ "maximum": 10
+ },
+ "required_review_thread_resolution": {
+ "type": "boolean",
+ "description": "All conversations on code must be resolved before a pull request can be merged."
+ }
+ },
+ "required": [
+ "dismiss_stale_reviews_on_push",
+ "require_code_owner_review",
+ "require_last_push_approval",
+ "required_approving_review_count",
+ "required_review_thread_resolution"
+ ]
+ }
+ }
+ },
+ "repository-rule-params-status-check-configuration": {
+ "title": "StatusCheckConfiguration",
+ "description": "Required status check",
+ "type": "object",
+ "properties": {
+ "context": {
+ "type": "string",
+ "description": "The status check context name that must be present on the commit."
+ },
+ "integration_id": {
+ "type": "integer",
+ "description": "The optional integration ID that this status check must originate from."
+ }
+ },
+ "required": [
+ "context"
+ ]
+ },
+ "repository-rule-required-status-checks": {
+ "title": "required_status_checks",
+ "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "required_status_checks"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "required_status_checks": {
+ "type": "array",
+ "description": "Status checks that are required.",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule-params-status-check-configuration"
+ }
+ },
+ "strict_required_status_checks_policy": {
+ "type": "boolean",
+ "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled."
+ }
+ },
+ "required": [
+ "required_status_checks",
+ "strict_required_status_checks_policy"
+ ]
+ }
+ }
+ },
+ "repository-rule-non-fast-forward": {
+ "title": "non_fast_forward",
+ "description": "Prevent users with push access from force pushing to refs.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "non_fast_forward"
+ ]
+ }
+ }
+ },
+ "repository-rule-commit-message-pattern": {
+ "title": "commit_message_pattern",
+ "description": "Parameters to be used for the commit_message_pattern rule",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "commit_message_pattern"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "How this rule will appear to users."
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "If true, the rule will fail if the pattern matches."
+ },
+ "operator": {
+ "type": "string",
+ "description": "The operator to use for matching.",
+ "enum": [
+ "starts_with",
+ "ends_with",
+ "contains",
+ "regex"
+ ]
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The pattern to match with."
+ }
+ },
+ "required": [
+ "operator",
+ "pattern"
+ ]
+ }
+ }
+ },
+ "repository-rule-commit-author-email-pattern": {
+ "title": "commit_author_email_pattern",
+ "description": "Parameters to be used for the commit_author_email_pattern rule",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "commit_author_email_pattern"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "How this rule will appear to users."
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "If true, the rule will fail if the pattern matches."
+ },
+ "operator": {
+ "type": "string",
+ "description": "The operator to use for matching.",
+ "enum": [
+ "starts_with",
+ "ends_with",
+ "contains",
+ "regex"
+ ]
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The pattern to match with."
+ }
+ },
+ "required": [
+ "operator",
+ "pattern"
+ ]
+ }
+ }
+ },
+ "repository-rule-committer-email-pattern": {
+ "title": "committer_email_pattern",
+ "description": "Parameters to be used for the committer_email_pattern rule",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "committer_email_pattern"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "How this rule will appear to users."
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "If true, the rule will fail if the pattern matches."
+ },
+ "operator": {
+ "type": "string",
+ "description": "The operator to use for matching.",
+ "enum": [
+ "starts_with",
+ "ends_with",
+ "contains",
+ "regex"
+ ]
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The pattern to match with."
+ }
+ },
+ "required": [
+ "operator",
+ "pattern"
+ ]
+ }
+ }
+ },
+ "repository-rule-branch-name-pattern": {
+ "title": "branch_name_pattern",
+ "description": "Parameters to be used for the branch_name_pattern rule",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "branch_name_pattern"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "How this rule will appear to users."
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "If true, the rule will fail if the pattern matches."
+ },
+ "operator": {
+ "type": "string",
+ "description": "The operator to use for matching.",
+ "enum": [
+ "starts_with",
+ "ends_with",
+ "contains",
+ "regex"
+ ]
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The pattern to match with."
+ }
+ },
+ "required": [
+ "operator",
+ "pattern"
+ ]
+ }
+ }
+ },
+ "repository-rule-tag-name-pattern": {
+ "title": "tag_name_pattern",
+ "description": "Parameters to be used for the tag_name_pattern rule",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "tag_name_pattern"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "How this rule will appear to users."
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "If true, the rule will fail if the pattern matches."
+ },
+ "operator": {
+ "type": "string",
+ "description": "The operator to use for matching.",
+ "enum": [
+ "starts_with",
+ "ends_with",
+ "contains",
+ "regex"
+ ]
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The pattern to match with."
+ }
+ },
+ "required": [
+ "operator",
+ "pattern"
+ ]
+ }
+ }
+ },
+ "repository-rule-params-restricted-commits": {
+ "title": "RestrictedCommits",
+ "description": "Restricted commit",
+ "type": "object",
+ "properties": {
+ "oid": {
+ "type": "string",
+ "description": "Full or abbreviated commit hash to reject"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Reason for restriction"
+ }
+ },
+ "required": [
+ "oid"
+ ]
+ },
+ "repository-rule-params-workflow-file-reference": {
+ "title": "WorkflowFileReference",
+ "description": "A workflow that must run for this rule to pass",
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path to the workflow file"
+ },
+ "ref": {
+ "type": "string",
+ "description": "The ref (branch or tag) of the workflow file to use"
+ },
+ "repository_id": {
+ "type": "integer",
+ "description": "The ID of the repository where the workflow is defined"
+ },
+ "sha": {
+ "type": "string",
+ "description": "The commit SHA of the workflow file to use"
+ }
+ },
+ "required": [
+ "path",
+ "repository_id"
+ ]
+ },
+ "repository-rule-workflows": {
+ "title": "workflows",
+ "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "workflows"
+ ]
+ },
+ "parameters": {
+ "type": "object",
+ "properties": {
+ "workflows": {
+ "type": "array",
+ "description": "Workflows that must pass for this rule to pass.",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
+ }
+ }
+ },
+ "required": [
+ "workflows"
+ ]
+ }
+ }
+ },
+ "repository-rule": {
+ "title": "Repository Rule",
+ "type": "object",
+ "description": "A repository rule.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-creation"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-update"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-deletion"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-required-linear-history"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-required-deployments"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-required-signatures"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-pull-request"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-required-status-checks"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-non-fast-forward"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-commit-message-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-committer-email-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-branch-name-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-workflows"
+ }
+ ]
+ },
+ "repository-ruleset": {
+ "title": "Repository ruleset",
+ "type": "object",
+ "description": "A set of rules to apply when specified conditions are met.",
+ "required": [
+ "id",
+ "name",
+ "source",
+ "enforcement"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The ID of the ruleset"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the ruleset"
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the ruleset",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ },
+ "source_type": {
+ "type": "string",
+ "description": "The type of the source of the ruleset",
+ "enum": [
+ "Repository",
+ "Organization"
+ ]
+ },
+ "source": {
+ "type": "string",
+ "description": "The name of the source"
+ },
+ "enforcement": {
+ "$ref": "#/components/schemas/repository-rule-enforcement"
+ },
+ "bypass_actors": {
+ "type": "array",
+ "description": "The actors that can bypass the rules in this ruleset",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-bypass-actor"
+ }
+ },
+ "current_user_can_bypass": {
+ "type": "string",
+ "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.",
+ "enum": [
+ "always",
+ "pull_requests_only",
+ "never"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL of the ruleset"
+ }
+ }
+ },
+ "html": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The html URL of the ruleset"
+ }
+ }
+ }
+ }
+ },
+ "conditions": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ {
+ "$ref": "#/components/schemas/org-ruleset-conditions"
+ }
+ ]
+ },
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "rule-suites": {
+ "title": "Rule Suites",
+ "description": "Response",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The unique identifier of the rule insight."
+ },
+ "actor_id": {
+ "type": "integer",
+ "description": "The number that identifies the user."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The handle for the GitHub user account."
+ },
+ "before_sha": {
+ "type": "string",
+ "description": "The first commit sha before the push evaluation."
+ },
+ "after_sha": {
+ "type": "string",
+ "description": "The last commit sha in the push evaluation."
+ },
+ "ref": {
+ "type": "string",
+ "description": "The ref name that the evaluation ran on."
+ },
+ "repository_id": {
+ "type": "integer",
+ "description": "The ID of the repository associated with the rule evaluation."
+ },
+ "repository_name": {
+ "type": "string",
+ "description": "The name of the repository without the `.git` extension."
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z"
+ },
+ "result": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail",
+ "bypass"
+ ],
+ "description": "The result of the rule evaluations for rules with the `active` enforcement status."
+ },
+ "evaluation_result": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail"
+ ],
+ "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+ }
+ }
+ }
+ },
+ "rule-suite": {
+ "title": "Rule Suite",
+ "description": "Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The unique identifier of the rule insight."
+ },
+ "actor_id": {
+ "type": "integer",
+ "description": "The number that identifies the user.",
+ "nullable": true
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The handle for the GitHub user account.",
+ "nullable": true
+ },
+ "before_sha": {
+ "type": "string",
+ "description": "The first commit sha before the push evaluation."
+ },
+ "after_sha": {
+ "type": "string",
+ "description": "The last commit sha in the push evaluation."
+ },
+ "ref": {
+ "type": "string",
+ "description": "The ref name that the evaluation ran on."
+ },
+ "repository_id": {
+ "type": "integer",
+ "description": "The ID of the repository associated with the rule evaluation."
+ },
+ "repository_name": {
+ "type": "string",
+ "description": "The name of the repository without the `.git` extension."
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z"
+ },
+ "result": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail",
+ "bypass"
+ ],
+ "description": "The result of the rule evaluations for rules with the `active` enforcement status."
+ },
+ "evaluation_result": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail"
+ ],
+ "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
+ },
+ "rule_evaluations": {
+ "type": "array",
+ "description": "Details on the evaluated rules.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "rule_source": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of rule source."
+ },
+ "id": {
+ "type": "integer",
+ "nullable": true,
+ "description": "The ID of the rule source."
+ },
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "description": "The name of the rule source."
+ }
+ }
+ },
+ "enforcement": {
+ "type": "string",
+ "enum": [
+ "active",
+ "evaluate",
+ "deleted ruleset"
+ ],
+ "description": "The enforcement level of this rule source."
+ },
+ "result": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail"
+ ],
+ "description": "The result of the evaluation of the individual rule."
+ },
+ "rule_type": {
+ "type": "string",
+ "description": "The type of rule."
+ },
+ "details": {
+ "type": "string",
+ "description": "Any associated details with the rule evaluation."
+ }
+ }
+ }
+ }
+ }
+ },
+ "repository-advisory-vulnerability": {
+ "description": "A product affected by the vulnerability detailed in a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "ecosystem": {
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "The range of the package versions affected by the vulnerability.",
+ "nullable": true
+ },
+ "patched_versions": {
+ "type": "string",
+ "description": "The package version(s) that resolve the vulnerability.",
+ "nullable": true
+ },
+ "vulnerable_functions": {
+ "type": "array",
+ "description": "The functions in the package that are affected.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package",
+ "vulnerable_version_range",
+ "patched_versions",
+ "vulnerable_functions"
+ ],
+ "additionalProperties": false
+ },
+ "repository-advisory-credit": {
+ "description": "A credit given to a user for a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "type": {
+ "$ref": "#/components/schemas/security-advisory-credit-types"
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the user's acceptance of the credit.",
+ "enum": [
+ "accepted",
+ "declined",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "user",
+ "type",
+ "state"
+ ],
+ "additionalProperties": false
+ },
+ "repository-advisory": {
+ "description": "A repository security advisory.",
+ "type": "object",
+ "properties": {
+ "ghsa_id": {
+ "type": "string",
+ "description": "The GitHub Security Advisory ID.",
+ "readOnly": true
+ },
+ "cve_id": {
+ "type": "string",
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID.",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL for the advisory.",
+ "readOnly": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL for the advisory.",
+ "readOnly": true
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of what the advisory entails.",
+ "maxLength": 65535,
+ "nullable": true
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory.",
+ "nullable": true,
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low"
+ ]
+ },
+ "author": {
+ "readOnly": true,
+ "nullable": true,
+ "description": "The author of the advisory.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ ]
+ },
+ "publisher": {
+ "readOnly": true,
+ "nullable": true,
+ "description": "The publisher of the advisory.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ ]
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of identifier.",
+ "enum": [
+ "CVE",
+ "GHSA"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The identifier value."
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ]
+ },
+ "readOnly": true
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the advisory.",
+ "enum": [
+ "published",
+ "closed",
+ "withdrawn",
+ "draft",
+ "triage"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was created, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was last updated, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was published, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was closed, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "withdrawn_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.",
+ "readOnly": true,
+ "nullable": true
+ },
+ "submission": {
+ "type": "object",
+ "nullable": true,
+ "readOnly": true,
+ "properties": {
+ "accepted": {
+ "type": "boolean",
+ "description": "Whether a private vulnerability report was accepted by the repository's administrators.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "accepted"
+ ]
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/repository-advisory-vulnerability"
+ }
+ },
+ "cvss": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "vector_string": {
+ "type": "string",
+ "description": "The CVSS vector.",
+ "nullable": true
+ },
+ "score": {
+ "type": "number",
+ "description": "The CVSS score.",
+ "minimum": 0,
+ "maximum": 10,
+ "nullable": true,
+ "readOnly": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string",
+ "description": "The Common Weakness Enumeration (CWE) identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CWE.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ },
+ "readOnly": true
+ },
+ "cwe_ids": {
+ "type": "array",
+ "description": "A list of only the CWE IDs.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "credits": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The username of the user credited."
+ },
+ "type": {
+ "$ref": "#/components/schemas/security-advisory-credit-types"
+ }
+ }
+ }
+ },
+ "credits_detailed": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/repository-advisory-credit"
+ },
+ "readOnly": true
+ },
+ "collaborating_users": {
+ "type": "array",
+ "description": "A list of users that collaborate on the advisory.",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "collaborating_teams": {
+ "type": "array",
+ "description": "A list of teams that collaborate on the advisory.",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "private_fork": {
+ "readOnly": true,
+ "nullable": true,
+ "description": "A temporary private fork of the advisory's repository for collaborating on a fix.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/simple-repository"
+ }
+ ]
+ }
+ },
+ "required": [
+ "ghsa_id",
+ "cve_id",
+ "url",
+ "html_url",
+ "summary",
+ "description",
+ "severity",
+ "author",
+ "publisher",
+ "identifiers",
+ "state",
+ "created_at",
+ "updated_at",
+ "published_at",
+ "closed_at",
+ "withdrawn_at",
+ "submission",
+ "vulnerabilities",
+ "cvss",
+ "cwes",
+ "cwe_ids",
+ "credits",
+ "credits_detailed",
+ "collaborating_users",
+ "collaborating_teams",
+ "private_fork"
+ ],
+ "additionalProperties": false
+ },
+ "team-simple": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ },
+ "actions-billing-usage": {
+ "type": "object",
+ "properties": {
+ "total_minutes_used": {
+ "type": "integer",
+ "description": "The sum of the free and paid GitHub Actions minutes used."
+ },
+ "total_paid_minutes_used": {
+ "type": "integer",
+ "description": "The total paid GitHub Actions minutes used."
+ },
+ "included_minutes": {
+ "type": "integer",
+ "description": "The amount of free GitHub Actions minutes available."
+ },
+ "minutes_used_breakdown": {
+ "type": "object",
+ "properties": {
+ "UBUNTU": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu runner machines."
+ },
+ "MACOS": {
+ "type": "integer",
+ "description": "Total minutes used on macOS runner machines."
+ },
+ "WINDOWS": {
+ "type": "integer",
+ "description": "Total minutes used on Windows runner machines."
+ },
+ "ubuntu_4_core": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu 4 core runner machines."
+ },
+ "ubuntu_8_core": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu 8 core runner machines."
+ },
+ "ubuntu_16_core": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu 16 core runner machines."
+ },
+ "ubuntu_32_core": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu 32 core runner machines."
+ },
+ "ubuntu_64_core": {
+ "type": "integer",
+ "description": "Total minutes used on Ubuntu 64 core runner machines."
+ },
+ "windows_4_core": {
+ "type": "integer",
+ "description": "Total minutes used on Windows 4 core runner machines."
+ },
+ "windows_8_core": {
+ "type": "integer",
+ "description": "Total minutes used on Windows 8 core runner machines."
+ },
+ "windows_16_core": {
+ "type": "integer",
+ "description": "Total minutes used on Windows 16 core runner machines."
+ },
+ "windows_32_core": {
+ "type": "integer",
+ "description": "Total minutes used on Windows 32 core runner machines."
+ },
+ "windows_64_core": {
+ "type": "integer",
+ "description": "Total minutes used on Windows 64 core runner machines."
+ },
+ "macos_12_core": {
+ "type": "integer",
+ "description": "Total minutes used on macOS 12 core runner machines."
+ },
+ "total": {
+ "type": "integer",
+ "description": "Total minutes used on all runner machines."
+ }
+ }
+ }
+ },
+ "required": [
+ "total_minutes_used",
+ "total_paid_minutes_used",
+ "included_minutes",
+ "minutes_used_breakdown"
+ ]
+ },
+ "packages-billing-usage": {
+ "type": "object",
+ "properties": {
+ "total_gigabytes_bandwidth_used": {
+ "type": "integer",
+ "description": "Sum of the free and paid storage space (GB) for GitHuub Packages."
+ },
+ "total_paid_gigabytes_bandwidth_used": {
+ "type": "integer",
+ "description": "Total paid storage space (GB) for GitHuub Packages."
+ },
+ "included_gigabytes_bandwidth": {
+ "type": "integer",
+ "description": "Free storage space (GB) for GitHub Packages."
+ }
+ },
+ "required": [
+ "total_gigabytes_bandwidth_used",
+ "total_paid_gigabytes_bandwidth_used",
+ "included_gigabytes_bandwidth"
+ ]
+ },
+ "combined-billing-usage": {
+ "type": "object",
+ "properties": {
+ "days_left_in_billing_cycle": {
+ "type": "integer",
+ "description": "Numbers of days left in billing cycle."
+ },
+ "estimated_paid_storage_for_month": {
+ "type": "integer",
+ "description": "Estimated storage space (GB) used in billing cycle."
+ },
+ "estimated_storage_for_month": {
+ "type": "integer",
+ "description": "Estimated sum of free and paid storage space (GB) used in billing cycle."
+ }
+ },
+ "required": [
+ "days_left_in_billing_cycle",
+ "estimated_paid_storage_for_month",
+ "estimated_storage_for_month"
+ ]
+ },
+ "team-organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
+ },
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
+ },
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
+ },
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "team-full": {
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/nullable-team-simple"
+ },
+ "members_count": {
+ "type": "integer",
+ "example": 3
+ },
+ "repos_count": {
+ "type": "integer",
+ "example": 10
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-07-14T16:53:42Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-08-17T12:37:15Z"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/team-organization"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "created_at",
+ "updated_at",
+ "members_count",
+ "repos_count",
+ "organization"
+ ]
+ },
+ "team-discussion": {
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body": {
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string",
+ "example": "Hi! This is an area for us to collaborate as a team
"
+ },
+ "body_version": {
+ "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
+ "example": "0307116bbf7ced493b8d8a346c650b71",
+ "type": "string"
+ },
+ "comments_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
+ },
+ "last_edited_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ },
+ "number": {
+ "description": "The unique sequence number of a team discussion.",
+ "example": 42,
+ "type": "integer"
+ },
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "comments_count",
+ "comments_url",
+ "created_at",
+ "last_edited_at",
+ "html_url",
+ "pinned",
+ "private",
+ "node_id",
+ "number",
+ "team_url",
+ "title",
+ "updated_at",
+ "url"
+ ]
+ },
+ "team-discussion-comment": {
+ "title": "Team Discussion Comment",
+ "description": "A reply to a discussion within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body": {
+ "description": "The main text of the comment.",
+ "example": "I agree with this suggestion.",
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string",
+ "example": "Do you like apples?
"
+ },
+ "body_version": {
+ "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
+ "example": "0307116bbf7ced493b8d8a346c650b71",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-15T23:53:58Z"
+ },
+ "last_edited_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ },
+ "number": {
+ "description": "The unique sequence number of a team discussion comment.",
+ "example": 42,
+ "type": "integer"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-15T23:53:58Z"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "discussion_url",
+ "html_url",
+ "node_id",
+ "number",
+ "updated_at",
+ "url"
+ ]
+ },
+ "reaction": {
+ "title": "Reaction",
+ "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDg6UmVhY3Rpb24x"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "content": {
+ "description": "The reaction to use",
+ "example": "heart",
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-05-20T20:09:31Z"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "user",
+ "content",
+ "created_at"
+ ]
+ },
+ "team-membership": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "team-project": {
+ "title": "Team Project",
+ "description": "A team's access to a project.",
+ "type": "object",
+ "properties": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "type": "boolean"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "read": {
+ "type": "boolean"
+ },
+ "write": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at",
+ "permissions"
+ ]
+ },
+ "team-repository": {
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "project-card": {
+ "title": "Project Card",
+ "description": "Project cards represent a scope of work.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/cards/1478"
+ },
+ "id": {
+ "description": "The project card's ID",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
+ },
+ "note": {
+ "type": "string",
+ "example": "Add payload for delete Project column",
+ "nullable": true
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-09-05T14:21:06Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-09-05T14:20:22Z"
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
+ "type": "boolean"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "project_id": {
+ "type": "string"
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "note",
+ "url",
+ "column_url",
+ "project_url",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "project-column": {
+ "title": "Project Column",
+ "description": "Project columns contain cards of work.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367/cards"
+ },
+ "id": {
+ "description": "The unique identifier of the project column",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
+ },
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-09-05T14:18:44Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-09-05T14:22:28Z"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "project_url",
+ "cards_url",
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "project-collaborator-permission": {
+ "title": "Project Collaborator Permission",
+ "description": "Project Collaborator Permission",
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "permission",
+ "user"
+ ]
+ },
+ "rate-limit": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ },
+ "used": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset",
+ "used"
+ ]
+ },
+ "rate-limit-overview": {
+ "title": "Rate Limit Overview",
+ "description": "Rate Limit Overview",
+ "type": "object",
+ "properties": {
+ "resources": {
+ "type": "object",
+ "properties": {
+ "core": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "graphql": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "search": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "code_search": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "source_import": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "integration_manifest": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "code_scanning_upload": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "actions_runner_registration": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "scim": {
+ "$ref": "#/components/schemas/rate-limit"
+ },
+ "dependency_snapshots": {
+ "$ref": "#/components/schemas/rate-limit"
+ }
+ },
+ "required": [
+ "core",
+ "search"
+ ]
+ },
+ "rate": {
+ "$ref": "#/components/schemas/rate-limit"
+ }
+ },
+ "required": [
+ "rate",
+ "resources"
+ ]
+ },
+ "artifact": {
+ "title": "Artifact",
+ "description": "An artifact",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 5
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOkNoZWNrU3VpdGU1"
+ },
+ "name": {
+ "description": "The name of the artifact.",
+ "type": "string",
+ "example": "AdventureWorks.Framework"
+ },
+ "size_in_bytes": {
+ "description": "The size in bytes of the artifact.",
+ "type": "integer",
+ "example": 12345
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5"
+ },
+ "archive_download_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip"
+ },
+ "expired": {
+ "description": "Whether or not the artifact has expired.",
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "workflow_run": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "id": {
+ "example": 10,
+ "type": "integer"
+ },
+ "repository_id": {
+ "example": 42,
+ "type": "integer"
+ },
+ "head_repository_id": {
+ "example": 42,
+ "type": "integer"
+ },
+ "head_branch": {
+ "example": "main",
+ "type": "string"
+ },
+ "head_sha": {
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "size_in_bytes",
+ "url",
+ "archive_download_url",
+ "expired",
+ "created_at",
+ "expires_at",
+ "updated_at"
+ ]
+ },
+ "actions-cache-list": {
+ "title": "Repository actions caches",
+ "description": "Repository actions caches",
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "description": "Total number of caches",
+ "type": "integer",
+ "example": 2
+ },
+ "actions_caches": {
+ "description": "Array of caches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 2
+ },
+ "ref": {
+ "type": "string",
+ "example": "refs/heads/main"
+ },
+ "key": {
+ "type": "string",
+ "example": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"
+ },
+ "version": {
+ "type": "string",
+ "example": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0"
+ },
+ "last_accessed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-01-24T22:45:36.000Z"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-01-24T22:45:36.000Z"
+ },
+ "size_in_bytes": {
+ "type": "integer",
+ "example": 1024
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "total_count",
+ "actions_caches"
+ ]
+ },
+ "job": {
+ "title": "Job",
+ "description": "Information of a job execution in a workflow run",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the job.",
+ "example": 21,
+ "type": "integer"
+ },
+ "run_id": {
+ "description": "The id of the associated workflow run.",
+ "example": 5,
+ "type": "integer"
+ },
+ "run_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
+ },
+ "run_attempt": {
+ "type": "integer",
+ "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDg6Q2hlY2tSdW40"
+ },
+ "head_sha": {
+ "description": "The SHA of the commit that is being run.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/runs/4",
+ "nullable": true
+ },
+ "status": {
+ "description": "The phase of the lifecycle that the job is currently in.",
+ "example": "queued",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "waiting"
+ ]
+ },
+ "conclusion": {
+ "description": "The outcome of the job.",
+ "example": "success",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ]
+ },
+ "created_at": {
+ "description": "The time that the job created, in ISO 8601 format.",
+ "example": "2019-08-08T08:00:00-07:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "started_at": {
+ "description": "The time that the job started, in ISO 8601 format.",
+ "example": "2019-08-08T08:00:00-07:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "completed_at": {
+ "description": "The time that the job finished, in ISO 8601 format.",
+ "example": "2019-08-08T08:00:00-07:00",
+ "format": "date-time",
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the job.",
+ "example": "test-coverage",
+ "type": "string"
+ },
+ "steps": {
+ "description": "Steps in this job.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number"
+ ],
+ "properties": {
+ "status": {
+ "description": "The phase of the lifecycle that the job is currently in.",
+ "example": "queued",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "conclusion": {
+ "description": "The outcome of the job.",
+ "example": "success",
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the job.",
+ "example": "test-coverage",
+ "type": "string"
+ },
+ "number": {
+ "type": "integer",
+ "example": 1
+ },
+ "started_at": {
+ "description": "The time that the step started, in ISO 8601 format.",
+ "example": "2019-08-08T08:00:00-07:00",
+ "format": "date-time",
+ "type": "string",
+ "nullable": true
+ },
+ "completed_at": {
+ "description": "The time that the job finished, in ISO 8601 format.",
+ "example": "2019-08-08T08:00:00-07:00",
+ "format": "date-time",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "check_run_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.",
+ "example": [
+ "self-hosted",
+ "foo",
+ "bar"
+ ]
+ },
+ "runner_id": {
+ "type": "integer",
+ "nullable": true,
+ "example": 1,
+ "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
+ },
+ "runner_name": {
+ "type": "string",
+ "nullable": true,
+ "example": "my runner",
+ "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
+ },
+ "runner_group_id": {
+ "type": "integer",
+ "nullable": true,
+ "example": 2,
+ "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
+ },
+ "runner_group_name": {
+ "type": "string",
+ "nullable": true,
+ "example": "my runner group",
+ "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true,
+ "example": "Build"
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true,
+ "example": "main"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "run_id",
+ "run_url",
+ "head_sha",
+ "workflow_name",
+ "head_branch",
+ "name",
+ "url",
+ "html_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "check_run_url",
+ "labels",
+ "runner_id",
+ "runner_name",
+ "runner_group_id",
+ "runner_group_name",
+ "created_at"
+ ]
+ },
+ "oidc-custom-sub-repo": {
+ "title": "Actions OIDC subject customization for a repository",
+ "description": "Actions OIDC subject customization for a repository",
+ "type": "object",
+ "properties": {
+ "use_default": {
+ "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.",
+ "type": "boolean"
+ },
+ "include_claim_keys": {
+ "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "use_default"
+ ]
+ },
+ "actions-secret": {
+ "title": "Actions Secret",
+ "description": "Set secrets for GitHub Actions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret.",
+ "example": "SECRET_TOKEN",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "actions-variable": {
+ "title": "Actions Variable",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the variable.",
+ "example": "USERNAME",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the variable.",
+ "example": "octocat",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-01-24T22:45:36.000Z"
+ },
+ "updated_at": {
+ "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-01-24T22:45:36.000Z"
+ }
+ },
+ "required": [
+ "name",
+ "value",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "actions-enabled": {
+ "type": "boolean",
+ "description": "Whether GitHub Actions is enabled on the repository."
+ },
+ "actions-repository-permissions": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "$ref": "#/components/schemas/actions-enabled"
+ },
+ "allowed_actions": {
+ "$ref": "#/components/schemas/allowed-actions"
+ },
+ "selected_actions_url": {
+ "$ref": "#/components/schemas/selected-actions-url"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "actions-workflow-access-to-repository": {
+ "type": "object",
+ "properties": {
+ "access_level": {
+ "type": "string",
+ "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.",
+ "enum": [
+ "none",
+ "user",
+ "organization"
+ ]
+ }
+ },
+ "required": [
+ "access_level"
+ ]
+ },
+ "referenced-workflow": {
+ "title": "Referenced workflow",
+ "description": "A workflow referenced/reused by the initial caller workflow",
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ },
+ "pull-request-minimal": {
+ "title": "Pull Request Minimal",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "number",
+ "url",
+ "head",
+ "base"
+ ]
+ },
+ "nullable-simple-commit": {
+ "title": "Simple Commit",
+ "description": "A commit.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd"
+ },
+ "tree_id": {
+ "type": "string",
+ "description": "SHA for the commit's tree"
+ },
+ "message": {
+ "description": "Message describing the purpose of the commit",
+ "example": "Fix #42",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "description": "Information about the Git author",
+ "properties": {
+ "name": {
+ "description": "Name of the commit's author",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ },
+ "email": {
+ "description": "Git email address of the commit's author",
+ "example": "monalisa.octocat@example.com",
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "nullable": true
+ },
+ "committer": {
+ "type": "object",
+ "description": "Information about the Git committer",
+ "properties": {
+ "name": {
+ "description": "Name of the commit's committer",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ },
+ "email": {
+ "description": "Git email address of the commit's committer",
+ "example": "monalisa.octocat@example.com",
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ],
+ "nullable": true
+ },
+ "workflow-run": {
+ "title": "Workflow Run",
+ "description": "An invocation of a workflow",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The ID of the workflow run.",
+ "example": 5
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the workflow run.",
+ "nullable": true,
+ "example": "Build"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOkNoZWNrU3VpdGU1"
+ },
+ "check_suite_id": {
+ "type": "integer",
+ "description": "The ID of the associated check suite.",
+ "example": 42
+ },
+ "check_suite_node_id": {
+ "type": "string",
+ "description": "The node ID of the associated check suite.",
+ "example": "MDEwOkNoZWNrU3VpdGU0Mg=="
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true,
+ "example": "master"
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that points to the version of the workflow being run.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "path": {
+ "description": "The full path of the workflow",
+ "example": "octocat/octo-repo/.github/workflows/ci.yml@main",
+ "type": "string"
+ },
+ "run_number": {
+ "type": "integer",
+ "description": "The auto incrementing run number for the workflow run.",
+ "example": 106
+ },
+ "run_attempt": {
+ "type": "integer",
+ "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
+ "example": 1
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/referenced-workflow"
+ }
+ },
+ "event": {
+ "type": "string",
+ "example": "push"
+ },
+ "status": {
+ "type": "string",
+ "nullable": true,
+ "example": "completed"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "example": "neutral"
+ },
+ "workflow_id": {
+ "type": "integer",
+ "description": "The ID of the parent workflow.",
+ "example": 5
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL to the workflow run.",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/suites/4"
+ },
+ "pull_requests": {
+ "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.",
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "$ref": "#/components/schemas/pull-request-minimal"
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "triggering_actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The start time of the latest run. Resets on re-run."
+ },
+ "jobs_url": {
+ "description": "The URL to the jobs for the workflow run.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
+ },
+ "logs_url": {
+ "description": "The URL to download the logs for the workflow run.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
+ },
+ "check_suite_url": {
+ "description": "The URL to the associated check suite.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/check-suites/12"
+ },
+ "artifacts_url": {
+ "description": "The URL to the artifacts for the workflow run.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
+ },
+ "cancel_url": {
+ "description": "The URL to cancel the workflow run.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
+ },
+ "rerun_url": {
+ "description": "The URL to rerun the workflow run.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
+ },
+ "previous_attempt_url": {
+ "nullable": true,
+ "description": "The URL to the previous attempted run of this workflow, if one exists.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
+ },
+ "workflow_url": {
+ "description": "The URL to the workflow.",
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
+ },
+ "head_commit": {
+ "$ref": "#/components/schemas/nullable-simple-commit"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "head_repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "head_repository_id": {
+ "type": "integer",
+ "example": 5
+ },
+ "display_title": {
+ "type": "string",
+ "example": "Simple Workflow",
+ "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_branch",
+ "run_number",
+ "display_title",
+ "event",
+ "status",
+ "conclusion",
+ "head_sha",
+ "path",
+ "workflow_id",
+ "url",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "head_commit",
+ "head_repository",
+ "repository",
+ "jobs_url",
+ "logs_url",
+ "check_suite_url",
+ "cancel_url",
+ "rerun_url",
+ "artifacts_url",
+ "workflow_url",
+ "pull_requests"
+ ]
+ },
+ "environment-approvals": {
+ "title": "Environment Approval",
+ "description": "An entry in the reviews log for environment deployments",
+ "type": "object",
+ "properties": {
+ "environments": {
+ "description": "The list of environments that were approved or rejected",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the environment.",
+ "example": 56780428,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
+ },
+ "name": {
+ "description": "The name of the environment.",
+ "example": "staging",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/environments/staging"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
+ },
+ "created_at": {
+ "description": "The time that the environment was created, in ISO 8601 format.",
+ "example": "2020-11-23T22:00:40Z",
+ "format": "date-time",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time that the environment was last updated, in ISO 8601 format.",
+ "example": "2020-11-23T22:00:40Z",
+ "format": "date-time",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "state": {
+ "description": "Whether deployment to the environment(s) was approved or rejected or pending (with comments)",
+ "enum": [
+ "approved",
+ "rejected",
+ "pending"
+ ],
+ "example": "approved",
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "comment": {
+ "type": "string",
+ "description": "The comment submitted with the deployment review",
+ "example": "Ship it!"
+ }
+ },
+ "required": [
+ "environments",
+ "state",
+ "user",
+ "comment"
+ ]
+ },
+ "review-custom-gates-comment-required": {
+ "type": "object",
+ "properties": {
+ "environment_name": {
+ "type": "string",
+ "description": "The name of the environment to approve or reject."
+ },
+ "comment": {
+ "type": "string",
+ "description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**"
+ }
+ },
+ "required": [
+ "environment_name",
+ "comment"
+ ]
+ },
+ "review-custom-gates-state-required": {
+ "type": "object",
+ "properties": {
+ "environment_name": {
+ "type": "string",
+ "description": "The name of the environment to approve or reject."
+ },
+ "state": {
+ "type": "string",
+ "description": "Whether to approve or reject deployment to the specified environments.",
+ "enum": [
+ "approved",
+ "rejected"
+ ]
+ },
+ "comment": {
+ "type": "string",
+ "description": "Optional comment to include with the review."
+ }
+ },
+ "required": [
+ "environment_name",
+ "state"
+ ]
+ },
+ "deployment-reviewer-type": {
+ "type": "string",
+ "description": "The type of reviewer.",
+ "enum": [
+ "User",
+ "Team"
+ ],
+ "example": "User"
+ },
+ "pending-deployment": {
+ "title": "Pending Deployment",
+ "description": "Details of a deployment that is waiting for protection rules to pass",
+ "type": "object",
+ "properties": {
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the environment.",
+ "example": 56780428,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
+ },
+ "name": {
+ "description": "The name of the environment.",
+ "example": "staging",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/environments/staging"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
+ }
+ }
+ },
+ "wait_timer": {
+ "type": "integer",
+ "description": "The set duration of the wait timer",
+ "example": 30
+ },
+ "wait_timer_started_at": {
+ "description": "The time that the wait timer began.",
+ "example": "2020-11-23T22:00:40Z",
+ "format": "date-time",
+ "type": "string",
+ "nullable": true
+ },
+ "current_user_can_approve": {
+ "description": "Whether the currently authenticated user can approve the deployment",
+ "type": "boolean",
+ "example": true
+ },
+ "reviewers": {
+ "type": "array",
+ "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/deployment-reviewer-type"
+ },
+ "reviewer": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ {
+ "$ref": "#/components/schemas/team"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "environment",
+ "wait_timer",
+ "wait_timer_started_at",
+ "current_user_can_approve",
+ "reviewers"
+ ]
+ },
+ "deployment": {
+ "title": "Deployment",
+ "description": "A request for a specific ref(branch,sha,tag) to be deployed",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1"
+ },
+ "id": {
+ "description": "Unique identifier of the deployment",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOkRlcGxveW1lbnQx"
+ },
+ "sha": {
+ "type": "string",
+ "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
+ },
+ "ref": {
+ "description": "The ref to deploy. This can be a branch, tag, or sha.",
+ "example": "topic-branch",
+ "type": "string"
+ },
+ "task": {
+ "description": "Parameter to specify a task to execute",
+ "example": "deploy",
+ "type": "string"
+ },
+ "payload": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": true
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "original_environment": {
+ "type": "string",
+ "example": "staging"
+ },
+ "environment": {
+ "description": "Name for the target deployment environment.",
+ "example": "production",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "Deploy request from hubot",
+ "nullable": true
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "transient_environment": {
+ "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "production_environment": {
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "environment",
+ "creator",
+ "payload",
+ "description",
+ "statuses_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "workflow-run-usage": {
+ "title": "Workflow Run Usage",
+ "description": "Workflow Run Usage",
+ "type": "object",
+ "properties": {
+ "billable": {
+ "type": "object",
+ "properties": {
+ "UBUNTU": {
+ "type": "object",
+ "required": [
+ "total_ms",
+ "jobs"
+ ],
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ },
+ "jobs": {
+ "type": "integer"
+ },
+ "job_runs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "job_id",
+ "duration_ms"
+ ],
+ "properties": {
+ "job_id": {
+ "type": "integer"
+ },
+ "duration_ms": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "MACOS": {
+ "type": "object",
+ "required": [
+ "total_ms",
+ "jobs"
+ ],
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ },
+ "jobs": {
+ "type": "integer"
+ },
+ "job_runs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "job_id",
+ "duration_ms"
+ ],
+ "properties": {
+ "job_id": {
+ "type": "integer"
+ },
+ "duration_ms": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "WINDOWS": {
+ "type": "object",
+ "required": [
+ "total_ms",
+ "jobs"
+ ],
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ },
+ "jobs": {
+ "type": "integer"
+ },
+ "job_runs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "job_id",
+ "duration_ms"
+ ],
+ "properties": {
+ "job_id": {
+ "type": "integer"
+ },
+ "duration_ms": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "run_duration_ms": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "billable"
+ ]
+ },
+ "workflow": {
+ "title": "Workflow",
+ "description": "A GitHub Actions workflow",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 5
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDg6V29ya2Zsb3cxMg=="
+ },
+ "name": {
+ "type": "string",
+ "example": "CI"
+ },
+ "path": {
+ "type": "string",
+ "example": "ruby.yaml"
+ },
+ "state": {
+ "type": "string",
+ "example": "active",
+ "enum": [
+ "active",
+ "deleted",
+ "disabled_fork",
+ "disabled_inactivity",
+ "disabled_manually"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-12-06T14:20:20.000Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-12-06T14:20:20.000Z"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml"
+ },
+ "badge_url": {
+ "type": "string",
+ "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg"
+ },
+ "deleted_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2019-12-06T14:20:20.000Z"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "path",
+ "state",
+ "url",
+ "html_url",
+ "badge_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "workflow-usage": {
+ "title": "Workflow Usage",
+ "description": "Workflow Usage",
+ "type": "object",
+ "properties": {
+ "billable": {
+ "type": "object",
+ "properties": {
+ "UBUNTU": {
+ "type": "object",
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ }
+ }
+ },
+ "MACOS": {
+ "type": "object",
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ }
+ }
+ },
+ "WINDOWS": {
+ "type": "object",
+ "properties": {
+ "total_ms": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "billable"
+ ]
+ },
+ "activity": {
+ "title": "Activity",
+ "description": "Activity",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1296269
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "before": {
+ "type": "string",
+ "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "description": "The SHA of the commit before the activity."
+ },
+ "after": {
+ "type": "string",
+ "example": "827efc6d56897b048c772eb4087f854f46256132",
+ "description": "The SHA of the commit after the activity."
+ },
+ "ref": {
+ "type": "string",
+ "example": "refs/heads/main",
+ "description": "The full Git reference, formatted as `refs/heads/`."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "description": "The time when the activity occurred."
+ },
+ "activity_type": {
+ "type": "string",
+ "example": "force_push",
+ "enum": [
+ "push",
+ "force_push",
+ "branch_deletion",
+ "branch_creation",
+ "pr_merge",
+ "merge_queue_merge"
+ ],
+ "description": "The type of the activity that was performed."
+ },
+ "actor": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "before",
+ "after",
+ "ref",
+ "timestamp",
+ "activity_type",
+ "actor"
+ ]
+ },
+ "autolink": {
+ "title": "Autolink reference",
+ "description": "An autolink reference.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "key_prefix": {
+ "description": "The prefix of a key that is linkified.",
+ "example": "TICKET-",
+ "type": "string"
+ },
+ "url_template": {
+ "description": "A template for the target URL that is generated if a key was found.",
+ "example": "https://example.com/TICKET?query=",
+ "type": "string"
+ },
+ "is_alphanumeric": {
+ "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
+ "example": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "key_prefix",
+ "url_template",
+ "is_alphanumeric"
+ ]
+ },
+ "check-automated-security-fixes": {
+ "title": "Check Automated Security Fixes",
+ "description": "Check Automated Security Fixes",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "example": true,
+ "description": "Whether automated security fixes are enabled for the repository."
+ },
+ "paused": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether automated security fixes are paused for the repository."
+ }
+ },
+ "required": [
+ "enabled",
+ "paused"
+ ]
+ },
+ "protected-branch-required-status-check": {
+ "title": "Protected Branch Required Status Check",
+ "description": "Protected Branch Required Status Check",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "enforcement_level": {
+ "type": "string"
+ },
+ "contexts": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "checks": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "context": {
+ "type": "string"
+ },
+ "app_id": {
+ "type": "integer",
+ "nullable": true
+ }
+ },
+ "required": [
+ "context",
+ "app_id"
+ ]
+ }
+ },
+ "contexts_url": {
+ "type": "string"
+ },
+ "strict": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "contexts",
+ "checks"
+ ]
+ },
+ "protected-branch-admin-enforced": {
+ "title": "Protected Branch Admin Enforced",
+ "description": "Protected Branch Admin Enforced",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins"
+ },
+ "enabled": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "url",
+ "enabled"
+ ]
+ },
+ "protected-branch-pull-request-review": {
+ "title": "Protected Branch Pull Request Review",
+ "description": "Protected Branch Pull Request Review",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions"
+ },
+ "dismissal_restrictions": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The list of users with review dismissal access.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "apps": {
+ "description": "The list of apps with review dismissal access.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ },
+ "url": {
+ "type": "string",
+ "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\""
+ },
+ "users_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\""
+ },
+ "teams_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\""
+ }
+ }
+ },
+ "bypass_pull_request_allowances": {
+ "type": "object",
+ "description": "Allow specific users, teams, or apps to bypass pull request requirements.",
+ "properties": {
+ "users": {
+ "description": "The list of users allowed to bypass pull request requirements.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "teams": {
+ "description": "The list of teams allowed to bypass pull request requirements.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "apps": {
+ "description": "The list of apps allowed to bypass pull request requirements.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ }
+ }
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "example": true
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "example": true
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 6,
+ "example": 2
+ },
+ "require_last_push_approval": {
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it.",
+ "type": "boolean",
+ "example": true,
+ "default": false
+ }
+ },
+ "required": [
+ "dismiss_stale_reviews",
+ "require_code_owner_reviews"
+ ]
+ },
+ "branch-restriction-policy": {
+ "title": "Branch Restriction Policy",
+ "description": "Branch Restriction Policy",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "users_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "apps_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "apps": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "public_members_url": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "\"\""
+ },
+ "html_url": {
+ "type": "string",
+ "example": "\"https://github.com/testorg-ea8ec76d71c3af4b\""
+ },
+ "followers_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\""
+ },
+ "following_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\""
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\""
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\""
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\""
+ },
+ "organizations_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\""
+ },
+ "received_events_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\""
+ },
+ "type": {
+ "type": "string",
+ "example": "\"Organization\""
+ },
+ "site_admin": {
+ "type": "boolean",
+ "example": false
+ }
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "external_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "type": "string"
+ },
+ "contents": {
+ "type": "string"
+ },
+ "issues": {
+ "type": "string"
+ },
+ "single_file": {
+ "type": "string"
+ }
+ }
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ },
+ "branch-protection": {
+ "title": "Branch Protection",
+ "description": "Branch Protection",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "required_status_checks": {
+ "$ref": "#/components/schemas/protected-branch-required-status-check"
+ },
+ "enforce_admins": {
+ "$ref": "#/components/schemas/protected-branch-admin-enforced"
+ },
+ "required_pull_request_reviews": {
+ "$ref": "#/components/schemas/protected-branch-pull-request-review"
+ },
+ "restrictions": {
+ "$ref": "#/components/schemas/branch-restriction-policy"
+ },
+ "required_linear_history": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "allow_force_pushes": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "allow_deletions": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "block_creations": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "required_conversation_resolution": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "name": {
+ "type": "string",
+ "example": "\"branch/with/protection\""
+ },
+ "protection_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\""
+ },
+ "required_signatures": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures"
+ },
+ "enabled": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "url",
+ "enabled"
+ ]
+ },
+ "lock_branch": {
+ "type": "object",
+ "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.",
+ "properties": {
+ "enabled": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "allow_fork_syncing": {
+ "type": "object",
+ "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.",
+ "properties": {
+ "enabled": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "short-branch": {
+ "title": "Short Branch",
+ "description": "Short Branch",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "protected": {
+ "type": "boolean"
+ },
+ "protection": {
+ "$ref": "#/components/schemas/branch-protection"
+ },
+ "protection_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "commit",
+ "protected"
+ ]
+ },
+ "nullable-git-user": {
+ "title": "Git User",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "\"Chris Wanstrath\""
+ },
+ "email": {
+ "type": "string",
+ "example": "\"chris@ozmm.org\""
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2007-10-29T02:42:39.000-07:00\""
+ }
+ },
+ "nullable": true
+ },
+ "verification": {
+ "title": "Verification",
+ "type": "object",
+ "properties": {
+ "verified": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "payload": {
+ "type": "string",
+ "nullable": true
+ },
+ "signature": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "verified",
+ "reason",
+ "payload",
+ "signature"
+ ]
+ },
+ "diff-entry": {
+ "title": "Diff Entry",
+ "description": "Diff Entry",
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "example": "bbcd538c8e72b8c175046e27cc8f907076331401"
+ },
+ "filename": {
+ "type": "string",
+ "example": "file1.txt"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "added",
+ "removed",
+ "modified",
+ "renamed",
+ "copied",
+ "changed",
+ "unchanged"
+ ],
+ "example": "added"
+ },
+ "additions": {
+ "type": "integer",
+ "example": 103
+ },
+ "deletions": {
+ "type": "integer",
+ "example": 21
+ },
+ "changes": {
+ "type": "integer",
+ "example": 124
+ },
+ "blob_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt"
+ },
+ "raw_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "patch": {
+ "type": "string",
+ "example": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
+ },
+ "previous_filename": {
+ "type": "string",
+ "example": "file.txt"
+ }
+ },
+ "required": [
+ "additions",
+ "blob_url",
+ "changes",
+ "contents_url",
+ "deletions",
+ "filename",
+ "raw_url",
+ "sha",
+ "status"
+ ]
+ },
+ "commit": {
+ "title": "Commit",
+ "description": "Commit",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "sha": {
+ "type": "string",
+ "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "author": {
+ "$ref": "#/components/schemas/nullable-git-user"
+ },
+ "committer": {
+ "$ref": "#/components/schemas/nullable-git-user"
+ },
+ "message": {
+ "type": "string",
+ "example": "Fix all the bugs"
+ },
+ "comment_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "example": "827efc6d56897b048c772eb4087f854f46256132"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "verification": {
+ "$ref": "#/components/schemas/verification"
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "committer": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ }
+ },
+ "stats": {
+ "type": "object",
+ "properties": {
+ "additions": {
+ "type": "integer"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "total": {
+ "type": "integer"
+ }
+ }
+ },
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/diff-entry"
+ }
+ }
+ },
+ "required": [
+ "url",
+ "sha",
+ "node_id",
+ "html_url",
+ "comments_url",
+ "commit",
+ "author",
+ "committer",
+ "parents"
+ ]
+ },
+ "branch-with-protection": {
+ "title": "Branch With Protection",
+ "description": "Branch With Protection",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "commit": {
+ "$ref": "#/components/schemas/commit"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "type": "string"
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "html",
+ "self"
+ ]
+ },
+ "protected": {
+ "type": "boolean"
+ },
+ "protection": {
+ "$ref": "#/components/schemas/branch-protection"
+ },
+ "protection_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "pattern": {
+ "type": "string",
+ "example": "\"mas*\""
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "example": 1
+ }
+ },
+ "required": [
+ "name",
+ "commit",
+ "_links",
+ "protection",
+ "protected",
+ "protection_url"
+ ]
+ },
+ "status-check-policy": {
+ "title": "Status Check Policy",
+ "description": "Status Check Policy",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks"
+ },
+ "strict": {
+ "type": "boolean",
+ "example": true
+ },
+ "contexts": {
+ "type": "array",
+ "example": [
+ "continuous-integration/travis-ci"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "checks": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "context": {
+ "type": "string",
+ "example": "continuous-integration/travis-ci"
+ },
+ "app_id": {
+ "type": "integer",
+ "nullable": true
+ }
+ },
+ "required": [
+ "context",
+ "app_id"
+ ]
+ }
+ },
+ "contexts_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts"
+ }
+ },
+ "required": [
+ "url",
+ "contexts_url",
+ "strict",
+ "contexts",
+ "checks"
+ ]
+ },
+ "protected-branch": {
+ "title": "Protected Branch",
+ "description": "Branch protections protect branches",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "required_status_checks": {
+ "$ref": "#/components/schemas/status-check-policy"
+ },
+ "required_pull_request_reviews": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean"
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean"
+ },
+ "required_approving_review_count": {
+ "type": "integer"
+ },
+ "require_last_push_approval": {
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it.",
+ "type": "boolean",
+ "default": false
+ },
+ "dismissal_restrictions": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "users_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "users",
+ "teams"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "apps": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/integration"
+ }
+ }
+ },
+ "required": [
+ "users",
+ "teams"
+ ]
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "required_signatures": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures"
+ },
+ "enabled": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "url",
+ "enabled"
+ ]
+ },
+ "enforce_admins": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "url",
+ "enabled"
+ ]
+ },
+ "required_linear_history": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "enabled"
+ ]
+ },
+ "allow_force_pushes": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "enabled"
+ ]
+ },
+ "allow_deletions": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "enabled"
+ ]
+ },
+ "restrictions": {
+ "$ref": "#/components/schemas/branch-restriction-policy"
+ },
+ "required_conversation_resolution": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "block_creations": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "enabled"
+ ]
+ },
+ "lock_branch": {
+ "type": "object",
+ "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.",
+ "properties": {
+ "enabled": {
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ "allow_fork_syncing": {
+ "type": "object",
+ "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.",
+ "properties": {
+ "enabled": {
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "deployment-simple": {
+ "title": "Deployment",
+ "description": "A deployment created as the result of an Actions check run from a workflow that references an environment",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1"
+ },
+ "id": {
+ "description": "Unique identifier of the deployment",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOkRlcGxveW1lbnQx"
+ },
+ "task": {
+ "description": "Parameter to specify a task to execute",
+ "example": "deploy",
+ "type": "string"
+ },
+ "original_environment": {
+ "type": "string",
+ "example": "staging"
+ },
+ "environment": {
+ "description": "Name for the target deployment environment.",
+ "example": "production",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "Deploy request from hubot",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "transient_environment": {
+ "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "production_environment": {
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "task",
+ "environment",
+ "description",
+ "statuses_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "check-run": {
+ "title": "CheckRun",
+ "description": "A check performed on the code of a given code change",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the check.",
+ "example": 21,
+ "type": "integer"
+ },
+ "head_sha": {
+ "description": "The SHA of the commit that is being checked.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDg6Q2hlY2tSdW40"
+ },
+ "external_id": {
+ "type": "string",
+ "example": "42",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/runs/4",
+ "nullable": true
+ },
+ "details_url": {
+ "type": "string",
+ "example": "https://example.com",
+ "nullable": true
+ },
+ "status": {
+ "description": "The phase of the lifecycle that the check is currently in.",
+ "example": "queued",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "conclusion": {
+ "type": "string",
+ "example": "neutral",
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ],
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-05-04T01:14:52Z",
+ "nullable": true
+ },
+ "completed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-05-04T01:14:52Z",
+ "nullable": true
+ },
+ "output": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "nullable": true
+ },
+ "summary": {
+ "type": "string",
+ "nullable": true
+ },
+ "text": {
+ "type": "string",
+ "nullable": true
+ },
+ "annotations_count": {
+ "type": "integer"
+ },
+ "annotations_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "title",
+ "summary",
+ "text",
+ "annotations_count",
+ "annotations_url"
+ ]
+ },
+ "name": {
+ "description": "The name of the check.",
+ "example": "test-coverage",
+ "type": "string"
+ },
+ "check_suite": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "nullable": true
+ },
+ "app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "pull_requests": {
+ "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-minimal"
+ }
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment-simple"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_sha",
+ "name",
+ "url",
+ "html_url",
+ "details_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "external_id",
+ "check_suite",
+ "output",
+ "app",
+ "pull_requests"
+ ]
+ },
+ "check-annotation": {
+ "title": "Check Annotation",
+ "description": "Check Annotation",
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "example": "README.md"
+ },
+ "start_line": {
+ "type": "integer",
+ "example": 2
+ },
+ "end_line": {
+ "type": "integer",
+ "example": 2
+ },
+ "start_column": {
+ "type": "integer",
+ "example": 5,
+ "nullable": true
+ },
+ "end_column": {
+ "type": "integer",
+ "example": 10,
+ "nullable": true
+ },
+ "annotation_level": {
+ "type": "string",
+ "example": "warning",
+ "nullable": true
+ },
+ "title": {
+ "type": "string",
+ "example": "Spell Checker",
+ "nullable": true
+ },
+ "message": {
+ "type": "string",
+ "example": "Check your spelling for 'banaas'.",
+ "nullable": true
+ },
+ "raw_details": {
+ "type": "string",
+ "example": "Do you mean 'bananas' or 'banana'?",
+ "nullable": true
+ },
+ "blob_href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "blob_href",
+ "start_line",
+ "end_line",
+ "start_column",
+ "end_column",
+ "annotation_level",
+ "title",
+ "message",
+ "raw_details"
+ ]
+ },
+ "simple-commit": {
+ "title": "Simple Commit",
+ "description": "A commit.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd"
+ },
+ "tree_id": {
+ "type": "string",
+ "description": "SHA for the commit's tree"
+ },
+ "message": {
+ "description": "Message describing the purpose of the commit",
+ "example": "Fix #42",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "description": "Information about the Git author",
+ "properties": {
+ "name": {
+ "description": "Name of the commit's author",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ },
+ "email": {
+ "description": "Git email address of the commit's author",
+ "example": "monalisa.octocat@example.com",
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "nullable": true
+ },
+ "committer": {
+ "type": "object",
+ "description": "Information about the Git committer",
+ "properties": {
+ "name": {
+ "description": "Name of the commit's committer",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ },
+ "email": {
+ "description": "Git email address of the commit's committer",
+ "example": "monalisa.octocat@example.com",
+ "type": "string",
+ "format": "email"
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "check-suite": {
+ "title": "CheckSuite",
+ "description": "A suite of checks performed on the code of a given code change",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 5
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOkNoZWNrU3VpdGU1"
+ },
+ "head_branch": {
+ "type": "string",
+ "example": "master",
+ "nullable": true
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that is being checked.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "example": "completed",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "example": "neutral",
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required",
+ "startup_failure",
+ "stale",
+ null
+ ],
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/check-suites/5",
+ "nullable": true
+ },
+ "before": {
+ "type": "string",
+ "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
+ "nullable": true
+ },
+ "after": {
+ "type": "string",
+ "example": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-minimal"
+ },
+ "nullable": true
+ },
+ "app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "head_commit": {
+ "$ref": "#/components/schemas/simple-commit"
+ },
+ "latest_check_runs_count": {
+ "type": "integer"
+ },
+ "check_runs_url": {
+ "type": "string"
+ },
+ "rerequestable": {
+ "type": "boolean"
+ },
+ "runs_rerequestable": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_branch",
+ "status",
+ "conclusion",
+ "head_sha",
+ "url",
+ "before",
+ "after",
+ "created_at",
+ "updated_at",
+ "app",
+ "head_commit",
+ "repository",
+ "latest_check_runs_count",
+ "check_runs_url",
+ "pull_requests"
+ ]
+ },
+ "check-suite-preference": {
+ "title": "Check Suite Preference",
+ "description": "Check suite configuration preferences for a repository.",
+ "type": "object",
+ "required": [
+ "preferences",
+ "repository"
+ ],
+ "properties": {
+ "preferences": {
+ "type": "object",
+ "properties": {
+ "auto_trigger_checks": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer"
+ },
+ "setting": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "app_id",
+ "setting"
+ ]
+ }
+ }
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ }
+ }
+ },
+ "code-scanning-alert-items": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "instances_url": {
+ "$ref": "#/components/schemas/alert-instances-url"
+ },
+ "state": {
+ "$ref": "#/components/schemas/code-scanning-alert-state"
+ },
+ "fixed_at": {
+ "$ref": "#/components/schemas/alert-fixed-at"
+ },
+ "dismissed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "dismissed_at": {
+ "$ref": "#/components/schemas/alert-dismissed-at"
+ },
+ "dismissed_reason": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
+ },
+ "dismissed_comment": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
+ },
+ "rule": {
+ "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
+ },
+ "tool": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
+ },
+ "most_recent_instance": {
+ "$ref": "#/components/schemas/code-scanning-alert-instance"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "instances_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool",
+ "most_recent_instance"
+ ]
+ },
+ "code-scanning-alert-rule": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "nullable": true,
+ "type": "string",
+ "description": "A unique identifier for the rule used to detect the alert."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the rule used to detect the alert."
+ },
+ "severity": {
+ "nullable": true,
+ "type": "string",
+ "description": "The severity of the alert.",
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error"
+ ]
+ },
+ "security_severity_level": {
+ "nullable": true,
+ "type": "string",
+ "description": "The security severity of the alert.",
+ "enum": [
+ "low",
+ "medium",
+ "high",
+ "critical"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the rule used to detect the alert."
+ },
+ "full_description": {
+ "type": "string",
+ "description": "description of the rule used to detect the alert."
+ },
+ "tags": {
+ "nullable": true,
+ "type": "array",
+ "description": "A set of tags applicable for the rule.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "help": {
+ "nullable": true,
+ "type": "string",
+ "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
+ },
+ "help_uri": {
+ "nullable": true,
+ "type": "string",
+ "description": "A link to the documentation for the rule used to detect the alert."
+ }
+ }
+ },
+ "code-scanning-alert": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "instances_url": {
+ "$ref": "#/components/schemas/alert-instances-url"
+ },
+ "state": {
+ "$ref": "#/components/schemas/code-scanning-alert-state"
+ },
+ "fixed_at": {
+ "$ref": "#/components/schemas/alert-fixed-at"
+ },
+ "dismissed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "dismissed_at": {
+ "$ref": "#/components/schemas/alert-dismissed-at"
+ },
+ "dismissed_reason": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
+ },
+ "dismissed_comment": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
+ },
+ "rule": {
+ "$ref": "#/components/schemas/code-scanning-alert-rule"
+ },
+ "tool": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
+ },
+ "most_recent_instance": {
+ "$ref": "#/components/schemas/code-scanning-alert-instance"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "instances_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool",
+ "most_recent_instance"
+ ]
+ },
+ "code-scanning-alert-set-state": {
+ "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed"
+ ]
+ },
+ "code-scanning-analysis-sarif-id": {
+ "type": "string",
+ "description": "An identifier for the upload.",
+ "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
+ },
+ "code-scanning-analysis-commit-sha": {
+ "description": "The SHA of the commit to which the analysis you are uploading relates.",
+ "type": "string",
+ "minLength": 40,
+ "maxLength": 40,
+ "pattern": "^[0-9a-fA-F]+$"
+ },
+ "code-scanning-analysis-environment": {
+ "type": "string",
+ "description": "Identifies the variable values associated with the environment in which this analysis was performed."
+ },
+ "code-scanning-analysis-created-at": {
+ "type": "string",
+ "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "code-scanning-analysis-url": {
+ "type": "string",
+ "description": "The REST API URL of the analysis resource.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "code-scanning-analysis": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "$ref": "#/components/schemas/code-scanning-ref"
+ },
+ "commit_sha": {
+ "$ref": "#/components/schemas/code-scanning-analysis-commit-sha"
+ },
+ "analysis_key": {
+ "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
+ },
+ "environment": {
+ "$ref": "#/components/schemas/code-scanning-analysis-environment"
+ },
+ "category": {
+ "$ref": "#/components/schemas/code-scanning-analysis-category"
+ },
+ "error": {
+ "type": "string",
+ "example": "error reading field xyz"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/code-scanning-analysis-created-at"
+ },
+ "results_count": {
+ "type": "integer",
+ "description": "The total number of results in the analysis."
+ },
+ "rules_count": {
+ "type": "integer",
+ "description": "The total number of rules used in the analysis."
+ },
+ "id": {
+ "type": "integer",
+ "description": "Unique identifier for this analysis."
+ },
+ "url": {
+ "$ref": "#/components/schemas/code-scanning-analysis-url"
+ },
+ "sarif_id": {
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
+ },
+ "tool": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool"
+ },
+ "deletable": {
+ "type": "boolean"
+ },
+ "warning": {
+ "type": "string",
+ "description": "Warning generated when processing the analysis",
+ "example": "123 results were ignored"
+ }
+ },
+ "required": [
+ "ref",
+ "commit_sha",
+ "analysis_key",
+ "environment",
+ "error",
+ "created_at",
+ "results_count",
+ "rules_count",
+ "id",
+ "url",
+ "sarif_id",
+ "tool",
+ "deletable",
+ "warning"
+ ]
+ },
+ "code-scanning-analysis-deletion": {
+ "title": "Analysis deletion",
+ "description": "Successful deletion of a code scanning analysis",
+ "type": "object",
+ "properties": {
+ "next_analysis_url": {
+ "type": "string",
+ "description": "Next deletable analysis in chain, without last analysis deletion confirmation",
+ "format": "uri",
+ "readOnly": true,
+ "nullable": true
+ },
+ "confirm_delete_url": {
+ "type": "string",
+ "description": "Next deletable analysis in chain, with last analysis deletion confirmation",
+ "format": "uri",
+ "readOnly": true,
+ "nullable": true
+ }
+ },
+ "required": [
+ "next_analysis_url",
+ "confirm_delete_url"
+ ]
+ },
+ "code-scanning-codeql-database": {
+ "title": "CodeQL Database",
+ "description": "A CodeQL database.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "The ID of the CodeQL database."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CodeQL database."
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the CodeQL database."
+ },
+ "uploader": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The MIME type of the CodeQL database file."
+ },
+ "size": {
+ "type": "integer",
+ "description": "The size of the CodeQL database file in bytes."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
+ },
+ "commit_oid": {
+ "type": "string",
+ "description": "The commit SHA of the repository at the time the CodeQL database was created.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "language",
+ "uploader",
+ "content_type",
+ "size",
+ "created_at",
+ "updated_at",
+ "url"
+ ]
+ },
+ "code-scanning-default-setup": {
+ "description": "Configuration for code scanning default setup.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "Code scanning default setup has been configured or not.",
+ "type": "string",
+ "enum": [
+ "configured",
+ "not-configured"
+ ]
+ },
+ "languages": {
+ "description": "Languages to be analyzed.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "c-cpp",
+ "csharp",
+ "go",
+ "java-kotlin",
+ "javascript-typescript",
+ "javascript",
+ "python",
+ "ruby",
+ "typescript",
+ "swift"
+ ]
+ }
+ },
+ "query_suite": {
+ "description": "CodeQL query suite to be used.",
+ "type": "string",
+ "enum": [
+ "default",
+ "extended"
+ ]
+ },
+ "updated_at": {
+ "description": "Timestamp of latest configuration update.",
+ "nullable": true,
+ "type": "string",
+ "format": "date-time",
+ "example": "2023-12-06T14:20:20.000Z"
+ },
+ "schedule": {
+ "description": "The frequency of the periodic analysis.",
+ "nullable": true,
+ "type": "string",
+ "enum": [
+ "weekly"
+ ]
+ }
+ }
+ },
+ "code-scanning-default-setup-update": {
+ "description": "Configuration for code scanning default setup.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "The desired state of code scanning default setup.",
+ "type": "string",
+ "enum": [
+ "configured",
+ "not-configured"
+ ]
+ },
+ "query_suite": {
+ "description": "CodeQL query suite to be used.",
+ "type": "string",
+ "enum": [
+ "default",
+ "extended"
+ ]
+ },
+ "languages": {
+ "description": "CodeQL languages to be analyzed.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "c-cpp",
+ "csharp",
+ "go",
+ "java-kotlin",
+ "javascript-typescript",
+ "python",
+ "ruby",
+ "swift"
+ ]
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "code-scanning-default-setup-update-response": {
+ "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.",
+ "type": "object",
+ "properties": {
+ "run_id": {
+ "description": "ID of the corresponding run.",
+ "type": "integer"
+ },
+ "run_url": {
+ "description": "URL of the corresponding run.",
+ "type": "string"
+ }
+ }
+ },
+ "code-scanning-ref-full": {
+ "type": "string",
+ "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.",
+ "pattern": "^refs/(heads|tags|pull)/.*$",
+ "example": "refs/heads/main"
+ },
+ "code-scanning-analysis-sarif-file": {
+ "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"",
+ "type": "string"
+ },
+ "code-scanning-sarifs-receipt": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
+ },
+ "url": {
+ "type": "string",
+ "description": "The REST API URL for checking the status of the upload.",
+ "format": "uri",
+ "readOnly": true
+ }
+ }
+ },
+ "code-scanning-sarifs-status": {
+ "type": "object",
+ "properties": {
+ "processing_status": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "complete",
+ "failed"
+ ],
+ "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed."
+ },
+ "analyses_url": {
+ "type": "string",
+ "description": "The REST API URL for getting the analyses associated with the upload.",
+ "format": "uri",
+ "readOnly": true,
+ "nullable": true
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Any errors that ocurred during processing of the delivery.",
+ "readOnly": true,
+ "nullable": true
+ }
+ }
+ },
+ "codeowners-errors": {
+ "title": "CODEOWNERS errors",
+ "description": "A list of errors found in a repo's CODEOWNERS file",
+ "type": "object",
+ "properties": {
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "line": {
+ "description": "The line number where this errors occurs.",
+ "type": "integer",
+ "example": 7
+ },
+ "column": {
+ "description": "The column number where this errors occurs.",
+ "type": "integer",
+ "example": 3
+ },
+ "source": {
+ "description": "The contents of the line where the error occurs.",
+ "type": "string",
+ "example": "* user"
+ },
+ "kind": {
+ "description": "The type of error.",
+ "type": "string",
+ "example": "Invalid owner"
+ },
+ "suggestion": {
+ "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.",
+ "type": "string",
+ "nullable": true,
+ "example": "The pattern `/` will never match anything, did you mean `*` instead?"
+ },
+ "message": {
+ "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).",
+ "type": "string",
+ "example": "Invalid owner on line 7:\n\n * user\n ^"
+ },
+ "path": {
+ "description": "The path of the file where the error occured.",
+ "type": "string",
+ "example": ".github/CODEOWNERS"
+ }
+ },
+ "required": [
+ "line",
+ "column",
+ "kind",
+ "message",
+ "path"
+ ]
+ }
+ }
+ },
+ "required": [
+ "errors"
+ ]
+ },
+ "codespace-machine": {
+ "type": "object",
+ "title": "Codespace machine",
+ "description": "A description of the machine powering a codespace.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the machine.",
+ "example": "standardLinux"
+ },
+ "display_name": {
+ "type": "string",
+ "description": "The display name of the machine includes cores, memory, and storage.",
+ "example": "4 cores, 16 GB RAM, 64 GB storage"
+ },
+ "operating_system": {
+ "type": "string",
+ "description": "The operating system of the machine.",
+ "example": "linux"
+ },
+ "storage_in_bytes": {
+ "type": "integer",
+ "description": "How much storage is available to the codespace.",
+ "example": 68719476736
+ },
+ "memory_in_bytes": {
+ "type": "integer",
+ "description": "How much memory is available to the codespace.",
+ "example": 17179869184
+ },
+ "cpus": {
+ "type": "integer",
+ "description": "How many cores are available to the codespace.",
+ "example": 4
+ },
+ "prebuild_availability": {
+ "type": "string",
+ "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.",
+ "example": "ready",
+ "enum": [
+ "none",
+ "ready",
+ "in_progress"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "display_name",
+ "operating_system",
+ "storage_in_bytes",
+ "memory_in_bytes",
+ "cpus",
+ "prebuild_availability"
+ ]
+ },
+ "codespaces-permissions-check-for-devcontainer": {
+ "title": "Codespaces Permissions Check",
+ "description": "Permission check result for a given devcontainer config.",
+ "type": "object",
+ "properties": {
+ "accepted": {
+ "description": "Whether the user has accepted the permissions defined by the devcontainer config",
+ "example": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "accepted"
+ ]
+ },
+ "repo-codespaces-secret": {
+ "title": "Codespaces Secret",
+ "description": "Set repository secrets for GitHub Codespaces.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret.",
+ "example": "SECRET_TOKEN",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "collaborator": {
+ "title": "Collaborator",
+ "description": "Collaborator",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "role_name"
+ ]
+ },
+ "repository-invitation": {
+ "title": "Repository Invitation",
+ "description": "Repository invitations let you manage who you collaborate with.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository invitation.",
+ "example": 42,
+ "type": "integer"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "invitee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "inviter": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "permissions": {
+ "description": "The permission associated with the invitation.",
+ "example": "read",
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "triage",
+ "maintain"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-06-13T14:52:50-05:00"
+ },
+ "expired": {
+ "description": "Whether or not the invitation has expired",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "URL for the repository invitation",
+ "example": "https://api.github.com/user/repository-invitations/1",
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World/invitations"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "permissions",
+ "inviter",
+ "invitee",
+ "repository",
+ "url",
+ "html_url",
+ "created_at"
+ ]
+ },
+ "nullable-collaborator": {
+ "title": "Collaborator",
+ "description": "Collaborator",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "role_name"
+ ],
+ "nullable": true
+ },
+ "repository-collaborator-permission": {
+ "title": "Repository Collaborator Permission",
+ "description": "Repository Collaborator Permission",
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string"
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-collaborator"
+ }
+ },
+ "required": [
+ "permission",
+ "role_name",
+ "user"
+ ]
+ },
+ "commit-comment": {
+ "title": "Commit Comment",
+ "description": "Commit Comment",
+ "type": "object",
+ "properties": {
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string",
+ "nullable": true
+ },
+ "position": {
+ "type": "integer",
+ "nullable": true
+ },
+ "line": {
+ "type": "integer",
+ "nullable": true
+ },
+ "commit_id": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "branch-short": {
+ "title": "Branch Short",
+ "description": "Branch Short",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "protected": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name",
+ "commit",
+ "protected"
+ ]
+ },
+ "link": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "auto-merge": {
+ "title": "Auto merge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "properties": {
+ "enabled_by": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "merge_method": {
+ "type": "string",
+ "description": "The merge method to use.",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ },
+ "commit_title": {
+ "type": "string",
+ "description": "Title for the merge commit message."
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Commit message for the merge commit."
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ],
+ "nullable": true
+ },
+ "pull-request-simple": {
+ "title": "Pull Request Simple",
+ "description": "Pull Request Simple",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOlB1bGxSZXF1ZXN0MQ=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347.diff"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "number": {
+ "type": "integer",
+ "example": 1347
+ },
+ "state": {
+ "type": "string",
+ "example": "open"
+ },
+ "locked": {
+ "type": "boolean",
+ "example": true
+ },
+ "title": {
+ "type": "string",
+ "example": "new-feature"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body": {
+ "type": "string",
+ "example": "Please pull these awesome changes",
+ "nullable": true
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "description",
+ "color",
+ "default"
+ ]
+ }
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/nullable-milestone"
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "example": "too heated",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "nullable": true
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ },
+ "nullable": true
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "$ref": "#/components/schemas/link"
+ },
+ "commits": {
+ "$ref": "#/components/schemas/link"
+ },
+ "statuses": {
+ "$ref": "#/components/schemas/link"
+ },
+ "html": {
+ "$ref": "#/components/schemas/link"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/link"
+ },
+ "review_comments": {
+ "$ref": "#/components/schemas/link"
+ },
+ "review_comment": {
+ "$ref": "#/components/schemas/link"
+ },
+ "self": {
+ "$ref": "#/components/schemas/link"
+ }
+ },
+ "required": [
+ "comments",
+ "commits",
+ "statuses",
+ "html",
+ "issue",
+ "review_comments",
+ "review_comment",
+ "self"
+ ]
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "auto_merge": {
+ "$ref": "#/components/schemas/auto-merge"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "example": false,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "_links",
+ "assignee",
+ "labels",
+ "base",
+ "body",
+ "closed_at",
+ "comments_url",
+ "commits_url",
+ "created_at",
+ "diff_url",
+ "head",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_url",
+ "merge_commit_sha",
+ "merged_at",
+ "milestone",
+ "number",
+ "patch_url",
+ "review_comment_url",
+ "review_comments_url",
+ "statuses_url",
+ "state",
+ "locked",
+ "title",
+ "updated_at",
+ "url",
+ "user",
+ "author_association",
+ "auto_merge"
+ ]
+ },
+ "simple-commit-status": {
+ "title": "Simple Commit Status",
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "context": {
+ "type": "string"
+ },
+ "target_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "required": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "description",
+ "id",
+ "node_id",
+ "state",
+ "context",
+ "target_url",
+ "avatar_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "combined-commit-status": {
+ "title": "Combined Commit Status",
+ "description": "Combined Commit Status",
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string"
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-commit-status"
+ }
+ },
+ "sha": {
+ "type": "string"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "commit_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "state",
+ "sha",
+ "total_count",
+ "statuses",
+ "repository",
+ "commit_url",
+ "url"
+ ]
+ },
+ "status": {
+ "title": "Status",
+ "description": "The status of a commit.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "target_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "context": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "url",
+ "avatar_url",
+ "id",
+ "node_id",
+ "state",
+ "description",
+ "target_url",
+ "context",
+ "created_at",
+ "updated_at",
+ "creator"
+ ]
+ },
+ "nullable-code-of-conduct-simple": {
+ "title": "Code Of Conduct Simple",
+ "description": "Code of Conduct Simple",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/github/docs/community/code_of_conduct"
+ },
+ "key": {
+ "type": "string",
+ "example": "citizen_code_of_conduct"
+ },
+ "name": {
+ "type": "string",
+ "example": "Citizen Code of Conduct"
+ },
+ "html_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md"
+ }
+ },
+ "required": [
+ "url",
+ "key",
+ "name",
+ "html_url"
+ ],
+ "nullable": true
+ },
+ "nullable-community-health-file": {
+ "title": "Community Health File",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url"
+ ],
+ "nullable": true
+ },
+ "community-profile": {
+ "title": "Community Profile",
+ "description": "Community Profile",
+ "type": "object",
+ "properties": {
+ "health_percentage": {
+ "type": "integer",
+ "example": 100
+ },
+ "description": {
+ "type": "string",
+ "example": "My first repository on GitHub!",
+ "nullable": true
+ },
+ "documentation": {
+ "type": "string",
+ "example": "example.com",
+ "nullable": true
+ },
+ "files": {
+ "type": "object",
+ "properties": {
+ "code_of_conduct": {
+ "$ref": "#/components/schemas/nullable-code-of-conduct-simple"
+ },
+ "code_of_conduct_file": {
+ "$ref": "#/components/schemas/nullable-community-health-file"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "contributing": {
+ "$ref": "#/components/schemas/nullable-community-health-file"
+ },
+ "readme": {
+ "$ref": "#/components/schemas/nullable-community-health-file"
+ },
+ "issue_template": {
+ "$ref": "#/components/schemas/nullable-community-health-file"
+ },
+ "pull_request_template": {
+ "$ref": "#/components/schemas/nullable-community-health-file"
+ }
+ },
+ "required": [
+ "code_of_conduct",
+ "code_of_conduct_file",
+ "license",
+ "contributing",
+ "readme",
+ "issue_template",
+ "pull_request_template"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-02-28T19:09:29Z",
+ "nullable": true
+ },
+ "content_reports_enabled": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "health_percentage",
+ "description",
+ "documentation",
+ "files",
+ "updated_at"
+ ]
+ },
+ "commit-comparison": {
+ "title": "Commit Comparison",
+ "description": "Commit Comparison",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/compare/master...topic"
+ },
+ "permalink_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/compare/master...topic.diff"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/compare/master...topic.patch"
+ },
+ "base_commit": {
+ "$ref": "#/components/schemas/commit"
+ },
+ "merge_base_commit": {
+ "$ref": "#/components/schemas/commit"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "diverged",
+ "ahead",
+ "behind",
+ "identical"
+ ],
+ "example": "ahead"
+ },
+ "ahead_by": {
+ "type": "integer",
+ "example": 4
+ },
+ "behind_by": {
+ "type": "integer",
+ "example": 5
+ },
+ "total_commits": {
+ "type": "integer",
+ "example": 6
+ },
+ "commits": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit"
+ }
+ },
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/diff-entry"
+ }
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "permalink_url",
+ "diff_url",
+ "patch_url",
+ "base_commit",
+ "merge_base_commit",
+ "status",
+ "ahead_by",
+ "behind_by",
+ "total_commits",
+ "commits"
+ ]
+ },
+ "content-tree": {
+ "title": "Content Tree",
+ "description": "Content Tree",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "entries": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url"
+ ]
+ }
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "content",
+ "encoding"
+ ]
+ },
+ "content-directory": {
+ "title": "Content Directory",
+ "description": "A list of directory items",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dir",
+ "file",
+ "submodule",
+ "symlink"
+ ]
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url"
+ ]
+ }
+ },
+ "content-file": {
+ "title": "Content File",
+ "description": "Content File",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "file"
+ ]
+ },
+ "encoding": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ },
+ "target": {
+ "type": "string",
+ "example": "\"actual/actual.md\""
+ },
+ "submodule_git_url": {
+ "type": "string",
+ "example": "\"git://example.com/defunkt/dotjs.git\""
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "content",
+ "encoding"
+ ]
+ },
+ "content-symlink": {
+ "title": "Symlink Content",
+ "description": "An object describing a symlink",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "symlink"
+ ]
+ },
+ "target": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "target"
+ ]
+ },
+ "content-submodule": {
+ "title": "Submodule Content",
+ "description": "An object describing a submodule",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "submodule"
+ ]
+ },
+ "submodule_git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "submodule_git_url"
+ ]
+ },
+ "file-commit": {
+ "title": "File Commit",
+ "description": "File Commit",
+ "type": "object",
+ "required": [
+ "content",
+ "commit"
+ ],
+ "properties": {
+ "content": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "string"
+ },
+ "git": {
+ "type": "string"
+ },
+ "html": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "nullable": true
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ }
+ }
+ },
+ "committer": {
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ }
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ }
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "verification": {
+ "type": "object",
+ "properties": {
+ "verified": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "signature": {
+ "type": "string",
+ "nullable": true
+ },
+ "payload": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "contributor": {
+ "title": "Contributor",
+ "description": "Contributor",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "contributions": {
+ "type": "integer"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "contributions",
+ "type"
+ ]
+ },
+ "dependabot-alert": {
+ "type": "object",
+ "description": "A Dependabot alert.",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the Dependabot alert.",
+ "readOnly": true,
+ "enum": [
+ "auto_dismissed",
+ "dismissed",
+ "fixed",
+ "open"
+ ]
+ },
+ "dependency": {
+ "type": "object",
+ "description": "Details for the vulnerable dependency.",
+ "readOnly": true,
+ "properties": {
+ "package": {
+ "$ref": "#/components/schemas/dependabot-alert-package"
+ },
+ "manifest_path": {
+ "type": "string",
+ "description": "The full path to the dependency manifest file, relative to the root of the repository.",
+ "readOnly": true
+ },
+ "scope": {
+ "type": "string",
+ "description": "The execution scope of the vulnerable dependency.",
+ "readOnly": true,
+ "nullable": true,
+ "enum": [
+ "development",
+ "runtime"
+ ]
+ }
+ }
+ },
+ "security_advisory": {
+ "$ref": "#/components/schemas/dependabot-alert-security-advisory"
+ },
+ "security_vulnerability": {
+ "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/alert-updated-at"
+ },
+ "dismissed_at": {
+ "$ref": "#/components/schemas/alert-dismissed-at"
+ },
+ "dismissed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "dismissed_reason": {
+ "type": "string",
+ "description": "The reason that the alert was dismissed.",
+ "nullable": true,
+ "enum": [
+ "fix_started",
+ "inaccurate",
+ "no_bandwidth",
+ "not_used",
+ "tolerable_risk"
+ ]
+ },
+ "dismissed_comment": {
+ "type": "string",
+ "description": "An optional comment associated with the alert's dismissal.",
+ "nullable": true,
+ "maxLength": 280
+ },
+ "fixed_at": {
+ "$ref": "#/components/schemas/alert-fixed-at"
+ },
+ "auto_dismissed_at": {
+ "$ref": "#/components/schemas/alert-auto-dismissed-at"
+ }
+ },
+ "required": [
+ "number",
+ "state",
+ "dependency",
+ "security_advisory",
+ "security_vulnerability",
+ "url",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "dismissed_at",
+ "dismissed_by",
+ "dismissed_reason",
+ "dismissed_comment",
+ "fixed_at"
+ ],
+ "additionalProperties": false
+ },
+ "dependabot-secret": {
+ "title": "Dependabot Secret",
+ "description": "Set secrets for Dependabot.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret.",
+ "example": "MY_ARTIFACTORY_PASSWORD",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "dependency-graph-diff": {
+ "title": "Dependency Graph Diff",
+ "description": "A diff of the dependencies between two commits.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "change_type": {
+ "type": "string",
+ "enum": [
+ "added",
+ "removed"
+ ]
+ },
+ "manifest": {
+ "type": "string",
+ "example": "path/to/package-lock.json"
+ },
+ "ecosystem": {
+ "type": "string",
+ "example": "npm"
+ },
+ "name": {
+ "type": "string",
+ "example": "@actions/core"
+ },
+ "version": {
+ "type": "string",
+ "example": "1.0.0"
+ },
+ "package_url": {
+ "type": "string",
+ "nullable": true,
+ "example": "pkg:/npm/%40actions/core@1.1.0"
+ },
+ "license": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "source_repository_url": {
+ "type": "string",
+ "nullable": true,
+ "example": "https://github.com/github/actions"
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "severity": {
+ "type": "string",
+ "example": "critical"
+ },
+ "advisory_ghsa_id": {
+ "type": "string",
+ "example": "GHSA-rf4j-j272-fj86"
+ },
+ "advisory_summary": {
+ "type": "string",
+ "example": "A summary of the advisory."
+ },
+ "advisory_url": {
+ "type": "string",
+ "example": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
+ }
+ },
+ "required": [
+ "severity",
+ "advisory_ghsa_id",
+ "advisory_summary",
+ "advisory_url"
+ ]
+ }
+ },
+ "scope": {
+ "description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.",
+ "type": "string",
+ "enum": [
+ "unknown",
+ "runtime",
+ "development"
+ ]
+ }
+ },
+ "required": [
+ "change_type",
+ "manifest",
+ "ecosystem",
+ "name",
+ "version",
+ "package_url",
+ "license",
+ "source_repository_url",
+ "vulnerabilities",
+ "scope"
+ ]
+ }
+ },
+ "dependency-graph-spdx-sbom": {
+ "title": "Dependency Graph SPDX SBOM",
+ "description": "A schema for the SPDX JSON format returned by the Dependency Graph.",
+ "type": "object",
+ "properties": {
+ "sbom": {
+ "type": "object",
+ "properties": {
+ "SPDXID": {
+ "type": "string",
+ "example": "SPDXRef-DOCUMENT",
+ "description": "The SPDX identifier for the SPDX document."
+ },
+ "spdxVersion": {
+ "type": "string",
+ "example": "SPDX-2.3",
+ "description": "The version of the SPDX specification that this document conforms to."
+ },
+ "creationInfo": {
+ "type": "object",
+ "properties": {
+ "created": {
+ "type": "string",
+ "example": "2021-11-03T00:00:00Z",
+ "description": "The date and time the SPDX document was created."
+ },
+ "creators": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "description": "The tools that were used to generate the SPDX document."
+ }
+ },
+ "required": [
+ "created",
+ "creators"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "example": "github/github",
+ "description": "The name of the SPDX document."
+ },
+ "dataLicense": {
+ "type": "string",
+ "example": "CC0-1.0",
+ "description": "The license under which the SPDX document is licensed."
+ },
+ "documentDescribes": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "github/github"
+ },
+ "description": "The name of the repository that the SPDX document describes."
+ },
+ "documentNamespace": {
+ "type": "string",
+ "example": "https://github.com/example/dependency_graph/sbom-123",
+ "description": "The namespace for the SPDX document."
+ },
+ "packages": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "SPDXID": {
+ "type": "string",
+ "example": "SPDXRef-Package",
+ "description": "A unique SPDX identifier for the package."
+ },
+ "name": {
+ "type": "string",
+ "example": "rubygems:github/github",
+ "description": "The name of the package."
+ },
+ "versionInfo": {
+ "type": "string",
+ "example": "1.0.0",
+ "description": "The version of the package. If the package does not have an exact version specified,\na version range is given."
+ },
+ "downloadLocation": {
+ "type": "string",
+ "example": "NOASSERTION",
+ "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined."
+ },
+ "filesAnalyzed": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document."
+ },
+ "licenseConcluded": {
+ "type": "string",
+ "example": "MIT",
+ "description": "The license of the package as determined while creating the SPDX document."
+ },
+ "licenseDeclared": {
+ "type": "string",
+ "example": "NOASSERTION",
+ "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created."
+ },
+ "supplier": {
+ "type": "string",
+ "example": "NOASSERTION",
+ "description": "The distribution source of this package, or NOASSERTION if this was not determined."
+ },
+ "externalRefs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "referenceCategory": {
+ "type": "string",
+ "example": "PACKAGE-MANAGER",
+ "description": "The category of reference to an external resource this reference refers to."
+ },
+ "referenceLocator": {
+ "type": "string",
+ "example": "pkg:gem/rails@6.0.1",
+ "description": "A locator for the particular external resource this reference refers to."
+ },
+ "referenceType": {
+ "type": "string",
+ "example": "purl",
+ "description": "The category of reference to an external resource this reference refers to."
+ }
+ },
+ "required": [
+ "referenceCategory",
+ "referenceLocator",
+ "referenceType"
+ ]
+ }
+ }
+ }
+ },
+ "required": [
+ "SPDXID",
+ "name",
+ "versionInfo",
+ "downloadLocation",
+ "filesAnalyzed",
+ "supplier"
+ ]
+ }
+ },
+ "required": [
+ "SPDXID",
+ "spdxVersion",
+ "creationInfo",
+ "name",
+ "dataLicense",
+ "documentDescribes",
+ "documentNamespace",
+ "packages"
+ ]
+ }
+ },
+ "required": [
+ "sbom"
+ ]
+ },
+ "metadata": {
+ "title": "metadata",
+ "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.",
+ "type": "object",
+ "maxProperties": 8,
+ "additionalProperties": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "properties": {
+ "package_url": {
+ "type": "string",
+ "description": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.",
+ "example": "pkg:/npm/%40actions/http-client@1.0.11",
+ "pattern": "^pkg"
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/metadata"
+ },
+ "relationship": {
+ "type": "string",
+ "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.",
+ "example": "direct",
+ "enum": [
+ "direct",
+ "indirect"
+ ]
+ },
+ "scope": {
+ "type": "string",
+ "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.",
+ "example": "runtime",
+ "enum": [
+ "runtime",
+ "development"
+ ]
+ },
+ "dependencies": {
+ "type": "array",
+ "description": "Array of package-url (PURLs) of direct child dependencies.",
+ "example": "@actions/http-client",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "manifest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the manifest.",
+ "example": "package-lock.json"
+ },
+ "file": {
+ "type": "object",
+ "properties": {
+ "source_location": {
+ "type": "string",
+ "description": "The path of the manifest file relative to the root of the Git repository.",
+ "example": "/src/build/package-lock.json"
+ }
+ },
+ "additionalProperties": false
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/metadata"
+ },
+ "resolved": {
+ "type": "object",
+ "description": "A collection of resolved package dependencies.",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/dependency"
+ }
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false
+ },
+ "snapshot": {
+ "title": "snapshot",
+ "description": "Create a new snapshot of a repository's dependencies.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "The version of the repository snapshot submission.",
+ "type": "integer"
+ },
+ "job": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The external ID of the job.",
+ "example": "5622a2b0-63f6-4732-8c34-a1ab27e102a11"
+ },
+ "correlator": {
+ "type": "string",
+ "description": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.",
+ "example": "yourworkflowname_yourjobname"
+ },
+ "html_url": {
+ "type": "string",
+ "description": "The url for the job.",
+ "example": "http://example.com/build"
+ }
+ },
+ "required": [
+ "id",
+ "correlator"
+ ],
+ "additionalProperties": false
+ },
+ "sha": {
+ "description": "The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.",
+ "type": "string",
+ "example": "ddc951f4b1293222421f2c8df679786153acf689",
+ "minLength": 40,
+ "maxLength": 40
+ },
+ "ref": {
+ "description": "The repository branch that triggered this snapshot.",
+ "type": "string",
+ "pattern": "^refs/",
+ "example": "refs/heads/main"
+ },
+ "detector": {
+ "type": "object",
+ "description": "A description of the detector used.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the detector used.",
+ "example": "docker buildtime detector"
+ },
+ "version": {
+ "type": "string",
+ "description": "The version of the detector used.",
+ "example": "1.0.0"
+ },
+ "url": {
+ "type": "string",
+ "description": "The url of the detector used.",
+ "example": "http://example.com/docker-buildtimer-detector"
+ }
+ },
+ "required": [
+ "name",
+ "version",
+ "url"
+ ],
+ "additionalProperties": false
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/metadata"
+ },
+ "manifests": {
+ "type": "object",
+ "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/manifest"
+ }
+ },
+ "scanned": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which the snapshot was scanned.",
+ "example": "2020-06-13T14:52:50-05:00"
+ }
+ },
+ "required": [
+ "detector",
+ "version",
+ "ref",
+ "sha",
+ "job",
+ "scanned"
+ ],
+ "additionalProperties": false
+ },
+ "deployment-status": {
+ "title": "Deployment Status",
+ "description": "The status of a deployment.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE2OkRlcGxveW1lbnRTdGF0dXMx"
+ },
+ "state": {
+ "description": "The state of the status.",
+ "enum": [
+ "error",
+ "failure",
+ "inactive",
+ "pending",
+ "success",
+ "queued",
+ "in_progress"
+ ],
+ "example": "success",
+ "type": "string"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "description": {
+ "description": "A short description of the status.",
+ "default": "",
+ "type": "string",
+ "maxLength": 140,
+ "example": "Deployment finished successfully."
+ },
+ "environment": {
+ "description": "The environment of the deployment that the status is for.",
+ "default": "",
+ "type": "string",
+ "example": "production"
+ },
+ "target_url": {
+ "description": "Deprecated: the URL to associate with this status.",
+ "default": "",
+ "type": "string",
+ "format": "uri",
+ "example": "https://example.com/deployment/42/output"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "deployment_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/42"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "environment_url": {
+ "description": "The URL for accessing your environment.",
+ "default": "",
+ "type": "string",
+ "format": "uri",
+ "example": "https://staging.example.com/"
+ },
+ "log_url": {
+ "description": "The URL to associate with this status.",
+ "default": "",
+ "type": "string",
+ "format": "uri",
+ "example": "https://example.com/deployment/42/output"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "state",
+ "creator",
+ "description",
+ "deployment_url",
+ "target_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "wait-timer": {
+ "type": "integer",
+ "example": 30,
+ "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
+ },
+ "deployment-branch-policy-settings": {
+ "type": "object",
+ "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
+ "properties": {
+ "protected_branches": {
+ "type": "boolean",
+ "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`."
+ },
+ "custom_branch_policies": {
+ "type": "boolean",
+ "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`."
+ }
+ },
+ "nullable": true,
+ "required": [
+ "protected_branches",
+ "custom_branch_policies"
+ ]
+ },
+ "environment": {
+ "title": "Environment",
+ "description": "Details of a deployment environment",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id of the environment.",
+ "example": 56780428,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
+ },
+ "name": {
+ "description": "The name of the environment.",
+ "example": "staging",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/github/hello-world/environments/staging"
+ },
+ "html_url": {
+ "type": "string",
+ "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
+ },
+ "created_at": {
+ "description": "The time that the environment was created, in ISO 8601 format.",
+ "example": "2020-11-23T22:00:40Z",
+ "format": "date-time",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time that the environment was last updated, in ISO 8601 format.",
+ "example": "2020-11-23T22:00:40Z",
+ "format": "date-time",
+ "type": "string"
+ },
+ "protection_rules": {
+ "type": "array",
+ "description": "Built-in deployment protection rules for the environment.",
+ "items": {
+ "anyOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3515
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6R2F0ZTM1MTU="
+ },
+ "type": {
+ "type": "string",
+ "example": "wait_timer"
+ },
+ "wait_timer": {
+ "$ref": "#/components/schemas/wait-timer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "type"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3755
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6R2F0ZTM3NTU="
+ },
+ "prevent_self_review": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether deployments to this environment can be approved by the user who created the deployment."
+ },
+ "type": {
+ "type": "string",
+ "example": "required_reviewers"
+ },
+ "reviewers": {
+ "type": "array",
+ "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "$ref": "#/components/schemas/deployment-reviewer-type"
+ },
+ "reviewer": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ {
+ "$ref": "#/components/schemas/team"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "type"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3515
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6R2F0ZTM1MTU="
+ },
+ "type": {
+ "type": "string",
+ "example": "branch_policy"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "type"
+ ]
+ }
+ ]
+ }
+ },
+ "deployment_branch_policy": {
+ "$ref": "#/components/schemas/deployment-branch-policy-settings"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "prevent-self-review": {
+ "type": "boolean",
+ "example": false,
+ "description": "Whether or not a user who created the job is prevented from approving their own job."
+ },
+ "deployment-branch-policy": {
+ "title": "Deployment branch policy",
+ "description": "Details of a deployment branch or tag policy.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The unique identifier of the branch or tag policy.",
+ "type": "integer",
+ "example": 361471
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
+ },
+ "name": {
+ "description": "The name pattern that branches or tags must match in order to deploy to the environment.",
+ "type": "string",
+ "example": "release/*"
+ },
+ "type": {
+ "description": "Whether this rule targets a branch or tag.",
+ "type": "string",
+ "example": "branch",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ }
+ }
+ },
+ "deployment-branch-policy-name-pattern-with-type": {
+ "title": "Deployment branch and tag policy name pattern",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
+ "type": "string",
+ "example": "release/*"
+ },
+ "type": {
+ "description": "Whether this rule targets a branch or tag",
+ "type": "string",
+ "example": "branch",
+ "enum": [
+ "branch",
+ "tag"
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "deployment-branch-policy-name-pattern": {
+ "title": "Deployment branch policy name pattern",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
+ "type": "string",
+ "example": "release/*"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "custom-deployment-rule-app": {
+ "title": "Custom deployment protection rule app",
+ "description": "A GitHub App that is providing a custom deployment protection rule.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3515,
+ "description": "The unique identifier of the deployment protection rule integration."
+ },
+ "slug": {
+ "type": "string",
+ "example": "my-custom-app",
+ "description": "The slugified name of the deployment protection rule integration."
+ },
+ "integration_url": {
+ "type": "string",
+ "example": "https://api.github.com/apps/custom-app-slug",
+ "description": "The URL for the endpoint to get details about the app."
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6R2F0ZTM1MTU=",
+ "description": "The node ID for the deployment protection rule integration."
+ }
+ },
+ "required": [
+ "id",
+ "slug",
+ "integration_url",
+ "node_id"
+ ]
+ },
+ "deployment-protection-rule": {
+ "title": "Deployment protection rule",
+ "description": "Deployment protection rule",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3515,
+ "description": "The unique identifier for the deployment protection rule."
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6R2F0ZTM1MTU=",
+ "description": "The node ID for the deployment protection rule."
+ },
+ "enabled": {
+ "type": "boolean",
+ "example": true,
+ "description": "Whether the deployment protection rule is enabled for the environment."
+ },
+ "app": {
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "enabled",
+ "app"
+ ]
+ },
+ "short-blob": {
+ "title": "Short Blob",
+ "description": "Short Blob",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "sha"
+ ]
+ },
+ "blob": {
+ "title": "Blob",
+ "description": "Blob",
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string"
+ },
+ "encoding": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "highlighted_content": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "node_id",
+ "size",
+ "content",
+ "encoding"
+ ]
+ },
+ "git-commit": {
+ "title": "Git Commit",
+ "description": "Low-level Git commit operations within a repository",
+ "type": "object",
+ "properties": {
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "description": "Identifying information for the git-user",
+ "type": "object",
+ "properties": {
+ "date": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "description": "Git email address of the user",
+ "example": "monalisa.octocat@example.com"
+ },
+ "name": {
+ "description": "Name of the git user",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name",
+ "date"
+ ]
+ },
+ "committer": {
+ "description": "Identifying information for the git-user",
+ "type": "object",
+ "properties": {
+ "date": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "description": "Git email address of the user",
+ "example": "monalisa.octocat@example.com"
+ },
+ "name": {
+ "description": "Name of the git user",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name",
+ "date"
+ ]
+ },
+ "message": {
+ "description": "Message describing the purpose of the commit",
+ "example": "Fix #42",
+ "type": "string"
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "html_url"
+ ]
+ }
+ },
+ "verification": {
+ "type": "object",
+ "properties": {
+ "verified": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "signature": {
+ "type": "string",
+ "nullable": true
+ },
+ "payload": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "verified",
+ "reason",
+ "signature",
+ "payload"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "node_id",
+ "url",
+ "html_url",
+ "author",
+ "committer",
+ "tree",
+ "message",
+ "parents",
+ "verification"
+ ]
+ },
+ "git-ref": {
+ "title": "Git Reference",
+ "description": "Git references within a repository",
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "object": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "sha": {
+ "description": "SHA for the reference",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string",
+ "minLength": 40,
+ "maxLength": 40
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "type",
+ "sha",
+ "url"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "node_id",
+ "url",
+ "object"
+ ]
+ },
+ "git-tag": {
+ "title": "Git Tag",
+ "description": "Metadata for a Git tag",
+ "type": "object",
+ "properties": {
+ "node_id": {
+ "type": "string",
+ "example": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw=="
+ },
+ "tag": {
+ "description": "Name of the tag",
+ "example": "v0.0.1",
+ "type": "string"
+ },
+ "sha": {
+ "type": "string",
+ "example": "940bd336248efae0f9ee5bc7b2d5c985887b16ac"
+ },
+ "url": {
+ "description": "URL for the tag",
+ "example": "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "type": "string",
+ "format": "uri"
+ },
+ "message": {
+ "description": "Message describing the purpose of the tag",
+ "example": "Initial public release",
+ "type": "string"
+ },
+ "tagger": {
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "date",
+ "email",
+ "name"
+ ]
+ },
+ "object": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "type",
+ "url"
+ ]
+ },
+ "verification": {
+ "$ref": "#/components/schemas/verification"
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "node_id",
+ "tagger",
+ "object",
+ "tag",
+ "message"
+ ]
+ },
+ "git-tree": {
+ "title": "Git Tree",
+ "description": "The hierarchy between files in a Git repository.",
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "tree": {
+ "description": "Objects specifying a tree structure",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "example": "test/file.rb"
+ },
+ "mode": {
+ "type": "string",
+ "example": "040000"
+ },
+ "type": {
+ "type": "string",
+ "example": "tree"
+ },
+ "sha": {
+ "type": "string",
+ "example": "23f6827669e43831def8a7ad935069c8bd418261"
+ },
+ "size": {
+ "type": "integer",
+ "example": 12
+ },
+ "url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261"
+ }
+ }
+ },
+ "example": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "size": 30,
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "mode": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha",
+ "url",
+ "size"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "tree",
+ "truncated"
+ ]
+ },
+ "hook-response": {
+ "title": "Hook Response",
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "integer",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "nullable": true
+ },
+ "message": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "code",
+ "status",
+ "message"
+ ]
+ },
+ "hook": {
+ "title": "Webhook",
+ "description": "Webhooks for repositories.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of a valid service, use 'web' for a webhook.",
+ "example": "web",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether the hook is actually triggered on pushes.",
+ "type": "boolean",
+ "example": true
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "config": {
+ "$ref": "#/components/schemas/webhook-config"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-09-06T20:39:23Z"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-09-06T17:26:27Z"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1"
+ },
+ "test_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test"
+ },
+ "ping_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings"
+ },
+ "deliveries_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries"
+ },
+ "last_response": {
+ "$ref": "#/components/schemas/hook-response"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at",
+ "last_response",
+ "test_url"
+ ]
+ },
+ "import": {
+ "title": "Import",
+ "description": "A repository import from an external source.",
+ "type": "object",
+ "properties": {
+ "vcs": {
+ "type": "string",
+ "nullable": true
+ },
+ "use_lfs": {
+ "type": "boolean"
+ },
+ "vcs_url": {
+ "description": "The URL of the originating repository.",
+ "type": "string"
+ },
+ "svc_root": {
+ "type": "string"
+ },
+ "tfvc_project": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "auth",
+ "error",
+ "none",
+ "detecting",
+ "choose",
+ "auth_failed",
+ "importing",
+ "mapping",
+ "waiting_to_push",
+ "pushing",
+ "complete",
+ "setup",
+ "unknown",
+ "detection_found_multiple",
+ "detection_found_nothing",
+ "detection_needs_auth"
+ ]
+ },
+ "status_text": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_step": {
+ "type": "string",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "nullable": true
+ },
+ "import_percent": {
+ "type": "integer",
+ "nullable": true
+ },
+ "commit_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "push_percent": {
+ "type": "integer",
+ "nullable": true
+ },
+ "has_large_files": {
+ "type": "boolean"
+ },
+ "large_files_size": {
+ "type": "integer"
+ },
+ "large_files_count": {
+ "type": "integer"
+ },
+ "project_choices": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "vcs": {
+ "type": "string"
+ },
+ "tfvc_project": {
+ "type": "string"
+ },
+ "human_name": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "authors_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "authors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_root": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "vcs",
+ "vcs_url",
+ "status",
+ "url",
+ "repository_url",
+ "html_url",
+ "authors_url"
+ ]
+ },
+ "porter-author": {
+ "title": "Porter Author",
+ "description": "Porter Author",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "remote_id": {
+ "type": "string"
+ },
+ "remote_name": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "import_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "remote_id",
+ "remote_name",
+ "email",
+ "name",
+ "url",
+ "import_url"
+ ]
+ },
+ "porter-large-file": {
+ "title": "Porter Large File",
+ "description": "Porter Large File",
+ "type": "object",
+ "properties": {
+ "ref_name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "oid": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "oid",
+ "path",
+ "ref_name",
+ "size"
+ ]
+ },
+ "nullable-issue": {
+ "title": "Issue",
+ "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "example": "https://api.github.com/repositories/42/issues/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "number": {
+ "description": "Number uniquely identifying the issue within its repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "example": "open",
+ "type": "string"
+ },
+ "state_reason": {
+ "description": "The reason for the current state",
+ "example": "not_planned",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "completed",
+ "reopened",
+ "not_planned"
+ ]
+ },
+ "title": {
+ "description": "Title of the issue",
+ "example": "Widget creation fails in Safari on OS X 10.8",
+ "type": "string"
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?",
+ "type": "string",
+ "nullable": true
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "labels": {
+ "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository",
+ "example": [
+ "bug",
+ "registration"
+ ],
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ },
+ "default": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/nullable-milestone"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "merged_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "diff_url",
+ "html_url",
+ "patch_url",
+ "url"
+ ]
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "closed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "assignee",
+ "closed_at",
+ "comments",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "labels",
+ "labels_url",
+ "milestone",
+ "number",
+ "repository_url",
+ "state",
+ "locked",
+ "title",
+ "url",
+ "user",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ],
+ "nullable": true
+ },
+ "issue-event-label": {
+ "title": "Issue Event Label",
+ "description": "Issue Event Label",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "color"
+ ]
+ },
+ "issue-event-dismissed-review": {
+ "title": "Issue Event Dismissed Review",
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string"
+ },
+ "review_id": {
+ "type": "integer"
+ },
+ "dismissal_message": {
+ "type": "string",
+ "nullable": true
+ },
+ "dismissal_commit_id": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "state",
+ "review_id",
+ "dismissal_message"
+ ]
+ },
+ "issue-event-milestone": {
+ "title": "Issue Event Milestone",
+ "description": "Issue Event Milestone",
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "issue-event-project-card": {
+ "title": "Issue Event Project Card",
+ "description": "Issue Event Project Card",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "project_id": {
+ "type": "integer"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "previous_column_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "project_url",
+ "project_id",
+ "column_name"
+ ]
+ },
+ "issue-event-rename": {
+ "title": "Issue Event Rename",
+ "description": "Issue Event Rename",
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from",
+ "to"
+ ]
+ },
+ "issue-event": {
+ "title": "Issue Event",
+ "description": "Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOklzc3VlRXZlbnQx"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "event": {
+ "type": "string",
+ "example": "closed"
+ },
+ "commit_id": {
+ "type": "string",
+ "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/nullable-issue"
+ },
+ "label": {
+ "$ref": "#/components/schemas/issue-event-label"
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "assigner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "review_requester": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "requested_reviewer": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "requested_team": {
+ "$ref": "#/components/schemas/team"
+ },
+ "dismissed_review": {
+ "$ref": "#/components/schemas/issue-event-dismissed-review"
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/issue-event-milestone"
+ },
+ "project_card": {
+ "$ref": "#/components/schemas/issue-event-project-card"
+ },
+ "rename": {
+ "$ref": "#/components/schemas/issue-event-rename"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at"
+ ]
+ },
+ "labeled-issue-event": {
+ "title": "Labeled Issue Event",
+ "description": "Labeled Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "label": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "color"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "unlabeled-issue-event": {
+ "title": "Unlabeled Issue Event",
+ "description": "Unlabeled Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "label": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "color"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "assigned-issue-event": {
+ "title": "Assigned Issue Event",
+ "description": "Assigned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/integration"
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "assigner": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app",
+ "assignee",
+ "assigner"
+ ]
+ },
+ "unassigned-issue-event": {
+ "title": "Unassigned Issue Event",
+ "description": "Unassigned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "assigner": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app",
+ "assignee",
+ "assigner"
+ ]
+ },
+ "milestoned-issue-event": {
+ "title": "Milestoned Issue Event",
+ "description": "Milestoned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "milestone": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title"
+ ]
+ }
+ },
+ "required": [
+ "milestone",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "demilestoned-issue-event": {
+ "title": "Demilestoned Issue Event",
+ "description": "Demilestoned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "milestone": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title"
+ ]
+ }
+ },
+ "required": [
+ "milestone",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "renamed-issue-event": {
+ "title": "Renamed Issue Event",
+ "description": "Renamed Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "rename": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from",
+ "to"
+ ]
+ }
+ },
+ "required": [
+ "rename",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "review-requested-issue-event": {
+ "title": "Review Requested Issue Event",
+ "description": "Review Requested Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "review_requester": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "requested_team": {
+ "$ref": "#/components/schemas/team"
+ },
+ "requested_reviewer": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "review_requester",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "review-request-removed-issue-event": {
+ "title": "Review Request Removed Issue Event",
+ "description": "Review Request Removed Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "review_requester": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "requested_team": {
+ "$ref": "#/components/schemas/team"
+ },
+ "requested_reviewer": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "review_requester",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "review-dismissed-issue-event": {
+ "title": "Review Dismissed Issue Event",
+ "description": "Review Dismissed Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "dismissed_review": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string"
+ },
+ "review_id": {
+ "type": "integer"
+ },
+ "dismissal_message": {
+ "nullable": true,
+ "type": "string"
+ },
+ "dismissal_commit_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "state",
+ "review_id",
+ "dismissal_message"
+ ]
+ }
+ },
+ "required": [
+ "dismissed_review",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "locked-issue-event": {
+ "title": "Locked Issue Event",
+ "description": "Locked Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "lock_reason": {
+ "type": "string",
+ "example": "\"off-topic\"",
+ "nullable": true
+ }
+ },
+ "required": [
+ "lock_reason",
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "added-to-project-issue-event": {
+ "title": "Added to Project Issue Event",
+ "description": "Added to Project Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "project_card": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "project_id": {
+ "type": "integer"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "previous_column_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "project_id",
+ "project_url",
+ "column_name"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "moved-column-in-project-issue-event": {
+ "title": "Moved Column in Project Issue Event",
+ "description": "Moved Column in Project Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "project_card": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "project_id": {
+ "type": "integer"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "previous_column_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "project_id",
+ "project_url",
+ "column_name"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "removed-from-project-issue-event": {
+ "title": "Removed from Project Issue Event",
+ "description": "Removed from Project Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "project_card": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "project_id": {
+ "type": "integer"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "previous_column_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "project_id",
+ "project_url",
+ "column_name"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "converted-note-to-issue-issue-event": {
+ "title": "Converted Note to Issue Issue Event",
+ "description": "Converted Note to Issue Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/integration"
+ },
+ "project_card": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "project_id": {
+ "type": "integer"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "column_name": {
+ "type": "string"
+ },
+ "previous_column_name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "project_id",
+ "project_url",
+ "column_name"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "issue-event-for-issue": {
+ "title": "Issue Event for Issue",
+ "description": "Issue Event for Issue",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/labeled-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/unlabeled-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/assigned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/unassigned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/milestoned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/demilestoned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/renamed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-requested-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-request-removed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-dismissed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/locked-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/added-to-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/moved-column-in-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/removed-from-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/converted-note-to-issue-issue-event"
+ }
+ ]
+ },
+ "label": {
+ "title": "Label",
+ "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 208045946
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDU6TGFiZWwyMDgwNDU5NDY="
+ },
+ "url": {
+ "description": "URL for the label",
+ "example": "https://api.github.com/repositories/42/labels/bug",
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "example": "bug",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "Something isn't working",
+ "nullable": true
+ },
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "example": "FFFFFF",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "description",
+ "color",
+ "default"
+ ]
+ },
+ "timeline-comment-event": {
+ "title": "Timeline Comment Event",
+ "description": "Timeline Comment Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "id": {
+ "description": "Unique identifier of the issue comment",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the issue comment",
+ "example": "https://api.github.com/repositories/42/issues/comments/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "body": {
+ "description": "Contents of the issue comment",
+ "example": "What version of Safari were you using when you observed this bug?",
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "event",
+ "actor",
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "timeline-cross-referenced-event": {
+ "title": "Timeline Cross Referenced Event",
+ "description": "Timeline Cross Referenced Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "source": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ }
+ },
+ "required": [
+ "event",
+ "created_at",
+ "updated_at",
+ "source"
+ ]
+ },
+ "timeline-committed-event": {
+ "title": "Timeline Committed Event",
+ "description": "Timeline Committed Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "description": "Identifying information for the git-user",
+ "type": "object",
+ "properties": {
+ "date": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "description": "Git email address of the user",
+ "example": "monalisa.octocat@example.com"
+ },
+ "name": {
+ "description": "Name of the git user",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name",
+ "date"
+ ]
+ },
+ "committer": {
+ "description": "Identifying information for the git-user",
+ "type": "object",
+ "properties": {
+ "date": {
+ "description": "Timestamp of the commit",
+ "example": "2014-08-09T08:02:04+12:00",
+ "format": "date-time",
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "description": "Git email address of the user",
+ "example": "monalisa.octocat@example.com"
+ },
+ "name": {
+ "description": "Name of the git user",
+ "example": "Monalisa Octocat",
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name",
+ "date"
+ ]
+ },
+ "message": {
+ "description": "Message describing the purpose of the commit",
+ "example": "Fix #42",
+ "type": "string"
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "description": "SHA for the commit",
+ "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "html_url"
+ ]
+ }
+ },
+ "verification": {
+ "type": "object",
+ "properties": {
+ "verified": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "signature": {
+ "type": "string",
+ "nullable": true
+ },
+ "payload": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "verified",
+ "reason",
+ "signature",
+ "payload"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "node_id",
+ "url",
+ "html_url",
+ "author",
+ "committer",
+ "tree",
+ "message",
+ "parents",
+ "verification"
+ ]
+ },
+ "timeline-reviewed-event": {
+ "title": "Timeline Reviewed Event",
+ "description": "Timeline Reviewed Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the review",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA="
+ },
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "body": {
+ "nullable": true,
+ "description": "The text of the review.",
+ "example": "This looks great.",
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "example": "CHANGES_REQUESTED"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "html",
+ "pull_request"
+ ]
+ },
+ "submitted_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "commit_id": {
+ "description": "A commit SHA for the review.",
+ "example": "54bb654c9e6025347f57900a4a5c2313a96b8035",
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ }
+ },
+ "required": [
+ "event",
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "state",
+ "commit_id",
+ "html_url",
+ "pull_request_url",
+ "_links",
+ "author_association"
+ ]
+ },
+ "pull-request-review-comment": {
+ "title": "Pull Request Review Comment",
+ "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL for the pull request review comment",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "type": "string"
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "example": 42,
+ "type": "integer",
+ "nullable": true
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "example": 1,
+ "type": "integer"
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string",
+ "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string",
+ "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..."
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "example": "config/database.yaml",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
+ "example": 1,
+ "type": "integer"
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
+ "example": 4,
+ "type": "integer"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "type": "string"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "example": 8,
+ "type": "integer"
+ },
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "example": "We should probably include a check for null values here.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "The first line of the range for a multi-line comment.",
+ "example": 2,
+ "nullable": true
+ },
+ "original_start_line": {
+ "type": "integer",
+ "description": "The first line of the range for a multi-line comment.",
+ "example": 2,
+ "nullable": true
+ },
+ "start_side": {
+ "type": "string",
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ],
+ "default": "RIGHT",
+ "nullable": true
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "example": 2,
+ "type": "integer"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "example": 2,
+ "type": "integer"
+ },
+ "side": {
+ "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ],
+ "default": "RIGHT",
+ "type": "string"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ },
+ "body_html": {
+ "type": "string",
+ "example": "\"comment body
\""
+ },
+ "body_text": {
+ "type": "string",
+ "example": "\"comment body\""
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "pull_request_review_id",
+ "diff_hunk",
+ "path",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links"
+ ]
+ },
+ "timeline-line-commented-event": {
+ "title": "Timeline Line Commented Event",
+ "description": "Timeline Line Commented Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "comments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-review-comment"
+ }
+ }
+ }
+ },
+ "timeline-commit-commented-event": {
+ "title": "Timeline Commit Commented Event",
+ "description": "Timeline Commit Commented Event",
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string"
+ },
+ "comments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/commit-comment"
+ }
+ }
+ }
+ },
+ "timeline-assigned-issue-event": {
+ "title": "Timeline Assigned Issue Event",
+ "description": "Timeline Assigned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app",
+ "assignee"
+ ]
+ },
+ "timeline-unassigned-issue-event": {
+ "title": "Timeline Unassigned Issue Event",
+ "description": "Timeline Unassigned Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app",
+ "assignee"
+ ]
+ },
+ "state-change-issue-event": {
+ "title": "State Change Issue Event",
+ "description": "State Change Issue Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "event": {
+ "type": "string"
+ },
+ "commit_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "commit_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at",
+ "performed_via_github_app"
+ ]
+ },
+ "timeline-issue-events": {
+ "title": "Timeline Event",
+ "description": "Timeline Event",
+ "type": "object",
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/labeled-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/unlabeled-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/milestoned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/demilestoned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/renamed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-requested-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-request-removed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/review-dismissed-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/locked-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/added-to-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/moved-column-in-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/removed-from-project-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/converted-note-to-issue-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-comment-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-cross-referenced-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-committed-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-reviewed-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-line-commented-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-commit-commented-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-assigned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/timeline-unassigned-issue-event"
+ },
+ {
+ "$ref": "#/components/schemas/state-change-issue-event"
+ }
+ ]
+ },
+ "deploy-key": {
+ "title": "Deploy Key",
+ "description": "An SSH key granting access to a single repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "key": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "read_only": {
+ "type": "boolean"
+ },
+ "added_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "last_used": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "key",
+ "url",
+ "title",
+ "verified",
+ "created_at",
+ "read_only"
+ ]
+ },
+ "language": {
+ "title": "Language",
+ "description": "Language",
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer"
+ }
+ },
+ "license-content": {
+ "title": "License Content",
+ "description": "License Content",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "encoding": {
+ "type": "string"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "git": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "git",
+ "html",
+ "self"
+ ]
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "content",
+ "encoding",
+ "license"
+ ]
+ },
+ "merged-upstream": {
+ "title": "Merged upstream",
+ "description": "Results of a successful merge upstream request",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "merge_type": {
+ "type": "string",
+ "enum": [
+ "merge",
+ "fast-forward",
+ "none"
+ ]
+ },
+ "base_branch": {
+ "type": "string"
+ }
+ }
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/milestones/v1.0"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1002604
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDk6TWlsZXN0b25lMTAwMjYwNA=="
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer",
+ "example": 42
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "example": "open",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open"
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "example": "v1.0",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "example": "Tracking milestone for version 1.0",
+ "nullable": true
+ },
+ "creator": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 4
+ },
+ "closed_issues": {
+ "type": "integer",
+ "example": 8
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-10T20:09:31Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2014-03-03T18:58:10Z"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2013-02-12T13:22:01Z",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-10-09T23:39:01Z",
+ "nullable": true
+ }
+ },
+ "required": [
+ "closed_issues",
+ "creator",
+ "description",
+ "due_on",
+ "closed_at",
+ "id",
+ "node_id",
+ "labels_url",
+ "html_url",
+ "number",
+ "open_issues",
+ "state",
+ "title",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pages-source-hash": {
+ "title": "Pages Source Hash",
+ "type": "object",
+ "properties": {
+ "branch": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "branch",
+ "path"
+ ]
+ },
+ "pages-https-certificate": {
+ "title": "Pages Https Certificate",
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "enum": [
+ "new",
+ "authorization_created",
+ "authorization_pending",
+ "authorized",
+ "authorization_revoked",
+ "issued",
+ "uploaded",
+ "approved",
+ "errored",
+ "bad_authz",
+ "destroy_pending",
+ "dns_changed"
+ ],
+ "example": "approved"
+ },
+ "description": {
+ "type": "string",
+ "example": "Certificate is approved"
+ },
+ "domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Array of the domain set and its alternate name (if it is configured)",
+ "example": [
+ "example.com",
+ "www.example.com"
+ ]
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date"
+ }
+ },
+ "required": [
+ "state",
+ "description",
+ "domains"
+ ]
+ },
+ "page": {
+ "title": "GitHub Pages",
+ "description": "The configuration for GitHub Pages for a repository.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The API address for accessing this Page resource.",
+ "format": "uri",
+ "example": "https://api.github.com/repos/github/hello-world/pages"
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the most recent build of the Page.",
+ "example": "built",
+ "enum": [
+ "built",
+ "building",
+ "errored"
+ ],
+ "nullable": true
+ },
+ "cname": {
+ "description": "The Pages site's custom domain",
+ "example": "example.com",
+ "type": "string",
+ "nullable": true
+ },
+ "protected_domain_state": {
+ "type": "string",
+ "description": "The state if the domain is verified",
+ "example": "pending",
+ "nullable": true,
+ "enum": [
+ "pending",
+ "verified",
+ "unverified"
+ ]
+ },
+ "pending_domain_unverified_at": {
+ "type": "string",
+ "description": "The timestamp when a pending domain becomes unverified.",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "custom_404": {
+ "type": "boolean",
+ "description": "Whether the Page has a custom 404 page.",
+ "example": false,
+ "default": false
+ },
+ "html_url": {
+ "type": "string",
+ "description": "The web address the Page can be accessed from.",
+ "format": "uri",
+ "example": "https://example.com"
+ },
+ "build_type": {
+ "type": "string",
+ "description": "The process in which the Page will be built.",
+ "example": "legacy",
+ "nullable": true,
+ "enum": [
+ "legacy",
+ "workflow"
+ ]
+ },
+ "source": {
+ "$ref": "#/components/schemas/pages-source-hash"
+ },
+ "public": {
+ "type": "boolean",
+ "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.",
+ "example": true
+ },
+ "https_certificate": {
+ "$ref": "#/components/schemas/pages-https-certificate"
+ },
+ "https_enforced": {
+ "type": "boolean",
+ "description": "Whether https is enabled on the domain",
+ "example": true
+ }
+ },
+ "required": [
+ "url",
+ "status",
+ "cname",
+ "custom_404",
+ "public"
+ ]
+ },
+ "page-build": {
+ "title": "Page Build",
+ "description": "Page Build",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "status": {
+ "type": "string"
+ },
+ "error": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "message"
+ ]
+ },
+ "pusher": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "commit": {
+ "type": "string"
+ },
+ "duration": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "url",
+ "status",
+ "error",
+ "pusher",
+ "commit",
+ "duration",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "page-build-status": {
+ "title": "Page Build Status",
+ "description": "Page Build Status",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/github/hello-world/pages/builds/latest"
+ },
+ "status": {
+ "type": "string",
+ "example": "queued"
+ }
+ },
+ "required": [
+ "url",
+ "status"
+ ]
+ },
+ "page-deployment": {
+ "title": "GitHub Pages",
+ "description": "The GitHub Pages deployment status.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit."
+ },
+ "status_url": {
+ "type": "string",
+ "description": "The URI to monitor GitHub Pages deployment status.",
+ "format": "uri",
+ "example": "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251"
+ },
+ "page_url": {
+ "type": "string",
+ "description": "The URI to the deployed GitHub Pages.",
+ "format": "uri",
+ "example": "hello-world.github.io"
+ },
+ "preview_url": {
+ "type": "string",
+ "description": "The URI to the deployed GitHub Pages preview.",
+ "format": "uri",
+ "example": "monalisa-1231a2312sa32-23sda74.drafts.github.io"
+ }
+ },
+ "required": [
+ "id",
+ "status_url",
+ "page_url"
+ ]
+ },
+ "pages-deployment-status": {
+ "title": "GitHub Pages deployment status",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The current status of the deployment.",
+ "enum": [
+ "deployment_in_progress",
+ "syncing_files",
+ "finished_file_sync",
+ "updating_pages",
+ "purging_cdn",
+ "deployment_cancelled",
+ "deployment_failed",
+ "deployment_content_failed",
+ "deployment_attempt_error",
+ "deployment_lost",
+ "succeed"
+ ]
+ }
+ }
+ },
+ "pages-health-check": {
+ "title": "Pages Health Check Status",
+ "description": "Pages Health Check Status",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "type": "object",
+ "properties": {
+ "host": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ },
+ "nameservers": {
+ "type": "string"
+ },
+ "dns_resolves": {
+ "type": "boolean"
+ },
+ "is_proxied": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cloudflare_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_fastly_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_old_ip_address": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_a_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "has_cname_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "has_mx_records_present": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_valid_domain": {
+ "type": "boolean"
+ },
+ "is_apex_domain": {
+ "type": "boolean"
+ },
+ "should_be_a_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_github_user_domain": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_pages_dot_github_dot_com": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_fastly": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_pointed_to_github_pages_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_non_github_pages_ip_present": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_pages_domain": {
+ "type": "boolean"
+ },
+ "is_served_by_pages": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_valid": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "responds_to_https": {
+ "type": "boolean"
+ },
+ "enforces_https": {
+ "type": "boolean"
+ },
+ "https_error": {
+ "type": "string",
+ "nullable": true
+ },
+ "is_https_eligible": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "caa_error": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "alt_domain": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "host": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ },
+ "nameservers": {
+ "type": "string"
+ },
+ "dns_resolves": {
+ "type": "boolean"
+ },
+ "is_proxied": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cloudflare_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_fastly_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_old_ip_address": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_a_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "has_cname_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "has_mx_records_present": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_valid_domain": {
+ "type": "boolean"
+ },
+ "is_apex_domain": {
+ "type": "boolean"
+ },
+ "should_be_a_record": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_github_user_domain": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_pages_dot_github_dot_com": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_cname_to_fastly": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_pointed_to_github_pages_ip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_non_github_pages_ip_present": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_pages_domain": {
+ "type": "boolean"
+ },
+ "is_served_by_pages": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "is_valid": {
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "responds_to_https": {
+ "type": "boolean"
+ },
+ "enforces_https": {
+ "type": "boolean"
+ },
+ "https_error": {
+ "type": "string",
+ "nullable": true
+ },
+ "is_https_eligible": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "caa_error": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "pull-request": {
+ "type": "object",
+ "title": "Pull Request",
+ "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOlB1bGxSZXF1ZXN0MQ=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347.diff"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment_url": {
+ "type": "string",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "example": 42,
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "example": "open",
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean",
+ "example": true
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "example": "Amazing new feature",
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "body": {
+ "type": "string",
+ "example": "Please pull these awesome changes",
+ "nullable": true
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "color": {
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "description",
+ "color",
+ "default"
+ ]
+ }
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/nullable-milestone"
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "example": "too heated",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "nullable": true
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team-simple"
+ },
+ "nullable": true
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "$ref": "#/components/schemas/link"
+ },
+ "commits": {
+ "$ref": "#/components/schemas/link"
+ },
+ "statuses": {
+ "$ref": "#/components/schemas/link"
+ },
+ "html": {
+ "$ref": "#/components/schemas/link"
+ },
+ "issue": {
+ "$ref": "#/components/schemas/link"
+ },
+ "review_comments": {
+ "$ref": "#/components/schemas/link"
+ },
+ "review_comment": {
+ "$ref": "#/components/schemas/link"
+ },
+ "self": {
+ "$ref": "#/components/schemas/link"
+ }
+ },
+ "required": [
+ "comments",
+ "commits",
+ "statuses",
+ "html",
+ "issue",
+ "review_comments",
+ "review_comment",
+ "self"
+ ]
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "auto_merge": {
+ "$ref": "#/components/schemas/auto-merge"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "example": false,
+ "type": "boolean"
+ },
+ "merged": {
+ "type": "boolean"
+ },
+ "mergeable": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string",
+ "example": "clean"
+ },
+ "merged_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "comments": {
+ "type": "integer",
+ "example": 10
+ },
+ "review_comments": {
+ "type": "integer",
+ "example": 0
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "example": true,
+ "type": "boolean"
+ },
+ "commits": {
+ "type": "integer",
+ "example": 3
+ },
+ "additions": {
+ "type": "integer",
+ "example": 100
+ },
+ "deletions": {
+ "type": "integer",
+ "example": 3
+ },
+ "changed_files": {
+ "type": "integer",
+ "example": 5
+ }
+ },
+ "required": [
+ "_links",
+ "assignee",
+ "labels",
+ "base",
+ "body",
+ "closed_at",
+ "comments_url",
+ "commits_url",
+ "created_at",
+ "diff_url",
+ "head",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_url",
+ "merge_commit_sha",
+ "merged_at",
+ "milestone",
+ "number",
+ "patch_url",
+ "review_comment_url",
+ "review_comments_url",
+ "statuses_url",
+ "state",
+ "locked",
+ "title",
+ "updated_at",
+ "url",
+ "user",
+ "author_association",
+ "auto_merge",
+ "additions",
+ "changed_files",
+ "comments",
+ "commits",
+ "deletions",
+ "mergeable",
+ "mergeable_state",
+ "merged",
+ "maintainer_can_modify",
+ "merged_by",
+ "review_comments"
+ ]
+ },
+ "pull-request-merge-result": {
+ "title": "Pull Request Merge Result",
+ "description": "Pull Request Merge Result",
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "merged",
+ "message",
+ "sha"
+ ]
+ },
+ "pull-request-review-request": {
+ "title": "Pull Request Review Request",
+ "description": "Pull Request Review Request",
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ }
+ },
+ "required": [
+ "users",
+ "teams"
+ ]
+ },
+ "pull-request-review": {
+ "title": "Pull Request Review",
+ "description": "Pull Request Reviews are reviews on pull requests.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the review",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA="
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body": {
+ "description": "The text of the review.",
+ "example": "This looks great.",
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "example": "CHANGES_REQUESTED"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "html",
+ "pull_request"
+ ]
+ },
+ "submitted_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "commit_id": {
+ "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.",
+ "example": "54bb654c9e6025347f57900a4a5c2313a96b8035",
+ "type": "string",
+ "nullable": true
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "state",
+ "commit_id",
+ "html_url",
+ "pull_request_url",
+ "_links",
+ "author_association"
+ ]
+ },
+ "review-comment": {
+ "title": "Legacy Review Comment",
+ "description": "Legacy Review Comment",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "pull_request_review_id": {
+ "type": "integer",
+ "example": 42,
+ "nullable": true
+ },
+ "id": {
+ "type": "integer",
+ "example": 10
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw"
+ },
+ "diff_hunk": {
+ "type": "string",
+ "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..."
+ },
+ "path": {
+ "type": "string",
+ "example": "file1.txt"
+ },
+ "position": {
+ "type": "integer",
+ "example": 1,
+ "nullable": true
+ },
+ "original_position": {
+ "type": "integer",
+ "example": 4
+ },
+ "commit_id": {
+ "type": "string",
+ "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "original_commit_id": {
+ "type": "string",
+ "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840"
+ },
+ "in_reply_to_id": {
+ "type": "integer",
+ "example": 8
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "body": {
+ "type": "string",
+ "example": "Great stuff"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "$ref": "#/components/schemas/link"
+ },
+ "html": {
+ "$ref": "#/components/schemas/link"
+ },
+ "pull_request": {
+ "$ref": "#/components/schemas/link"
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ],
+ "default": "RIGHT",
+ "type": "string"
+ },
+ "start_side": {
+ "type": "string",
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ],
+ "default": "RIGHT",
+ "nullable": true
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "example": 2,
+ "type": "integer"
+ },
+ "original_line": {
+ "description": "The original line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "example": 2,
+ "type": "integer"
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "example": 2,
+ "type": "integer",
+ "nullable": true
+ },
+ "original_start_line": {
+ "description": "The original first line of the range for a multi-line comment.",
+ "example": 2,
+ "type": "integer",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "body",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "pull_request_review_id",
+ "html_url",
+ "pull_request_url",
+ "_links",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "release-asset": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded",
+ "open"
+ ]
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "release": {
+ "title": "Release",
+ "description": "A release.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "upload_url": {
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "zipball_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "example": "v1.0.0",
+ "type": "string"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "example": "master",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "draft": {
+ "description": "true to create a draft (unpublished) release, false to create a published one.",
+ "example": false,
+ "type": "boolean"
+ },
+ "prerelease": {
+ "description": "Whether to identify the release as a prerelease or a full release.",
+ "example": false,
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "published_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "author": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/release-asset"
+ }
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "mentions_count": {
+ "type": "integer"
+ },
+ "discussion_url": {
+ "description": "The URL of the release discussion.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "assets_url",
+ "upload_url",
+ "tarball_url",
+ "zipball_url",
+ "created_at",
+ "published_at",
+ "draft",
+ "id",
+ "node_id",
+ "author",
+ "html_url",
+ "name",
+ "prerelease",
+ "tag_name",
+ "target_commitish",
+ "assets",
+ "url"
+ ]
+ },
+ "release-notes-content": {
+ "title": "Generated Release Notes Content",
+ "description": "Generated name and body describing a release",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The generated name of the release",
+ "type": "string",
+ "example": "Release v1.0.0 is now available!"
+ },
+ "body": {
+ "description": "The generated body describing the contents of the release supporting markdown formatting",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "body"
+ ]
+ },
+ "repository-rule-ruleset-info": {
+ "title": "repository ruleset data for rule",
+ "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.",
+ "properties": {
+ "ruleset_source_type": {
+ "type": "string",
+ "description": "The type of source for the ruleset that includes this rule.",
+ "enum": [
+ "Repository",
+ "Organization"
+ ]
+ },
+ "ruleset_source": {
+ "type": "string",
+ "description": "The name of the source of the ruleset that includes this rule."
+ },
+ "ruleset_id": {
+ "type": "integer",
+ "description": "The ID of the ruleset that includes this rule."
+ }
+ }
+ },
+ "repository-rule-detailed": {
+ "title": "Repository Rule",
+ "type": "object",
+ "description": "A repository rule with ruleset details.",
+ "oneOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-creation"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-update"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-deletion"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-required-linear-history"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-required-deployments"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-required-signatures"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-pull-request"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-required-status-checks"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-non-fast-forward"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-commit-message-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-committer-email-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-branch-name-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/repository-rule-workflows"
+ },
+ {
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
+ }
+ ]
+ }
+ ]
+ },
+ "secret-scanning-alert": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/nullable-alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "locations_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The REST API URL of the code locations for this alert."
+ },
+ "state": {
+ "$ref": "#/components/schemas/secret-scanning-alert-state"
+ },
+ "resolution": {
+ "$ref": "#/components/schemas/secret-scanning-alert-resolution"
+ },
+ "resolved_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "resolved_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "resolution_comment": {
+ "type": "string",
+ "description": "An optional comment to resolve an alert.",
+ "nullable": true
+ },
+ "secret_type": {
+ "type": "string",
+ "description": "The type of secret that secret scanning detected."
+ },
+ "secret_type_display_name": {
+ "type": "string",
+ "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "The secret that was detected."
+ },
+ "push_protection_bypassed": {
+ "type": "boolean",
+ "description": "Whether push protection was bypassed for the detected secret.",
+ "nullable": true
+ },
+ "push_protection_bypassed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "push_protection_bypassed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "validity": {
+ "type": "string",
+ "description": "The token status as of the latest validity check.",
+ "enum": [
+ "active",
+ "inactive",
+ "unknown"
+ ]
+ }
+ }
+ },
+ "secret-scanning-alert-resolution-comment": {
+ "description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.",
+ "type": "string",
+ "nullable": true
+ },
+ "secret-scanning-location-commit": {
+ "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The file path in the repository",
+ "example": "/example/secrets.txt"
+ },
+ "start_line": {
+ "type": "number",
+ "description": "Line number at which the secret starts in the file"
+ },
+ "end_line": {
+ "type": "number",
+ "description": "Line number at which the secret ends in the file"
+ },
+ "start_column": {
+ "type": "number",
+ "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII"
+ },
+ "end_column": {
+ "type": "number",
+ "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII"
+ },
+ "blob_sha": {
+ "type": "string",
+ "description": "SHA-1 hash ID of the associated blob",
+ "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
+ },
+ "blob_url": {
+ "type": "string",
+ "description": "The API URL to get the associated blob resource"
+ },
+ "commit_sha": {
+ "type": "string",
+ "description": "SHA-1 hash ID of the associated commit",
+ "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
+ },
+ "commit_url": {
+ "type": "string",
+ "description": "The API URL to get the associated commit resource"
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "start_column",
+ "end_column",
+ "blob_sha",
+ "blob_url",
+ "commit_sha",
+ "commit_url"
+ ]
+ },
+ "secret-scanning-location-issue-title": {
+ "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
+ "type": "object",
+ "properties": {
+ "issue_title_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the issue where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ }
+ },
+ "required": [
+ "issue_title_url"
+ ]
+ },
+ "secret-scanning-location-issue-body": {
+ "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.",
+ "type": "object",
+ "properties": {
+ "issue_body_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the issue where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ }
+ },
+ "required": [
+ "issue_body_url"
+ ]
+ },
+ "secret-scanning-location-issue-comment": {
+ "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.",
+ "type": "object",
+ "properties": {
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the issue comment where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451"
+ }
+ },
+ "required": [
+ "issue_comment_url"
+ ]
+ },
+ "secret-scanning-location-discussion-title": {
+ "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.",
+ "type": "object",
+ "properties": {
+ "discussion_title_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to the discussion where the secret was detected.",
+ "example": "https://github.com/community/community/discussions/39082"
+ }
+ },
+ "required": [
+ "discussion_title_url"
+ ]
+ },
+ "secret-scanning-location-discussion-body": {
+ "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.",
+ "type": "object",
+ "properties": {
+ "discussion_body_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to the discussion where the secret was detected.",
+ "example": "https://github.com/community/community/discussions/39082#discussion-4566270"
+ }
+ },
+ "required": [
+ "discussion_body_url"
+ ]
+ },
+ "secret-scanning-location-discussion-comment": {
+ "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.",
+ "type": "object",
+ "properties": {
+ "discussion_comment_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the discussion comment where the secret was detected.",
+ "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232"
+ }
+ },
+ "required": [
+ "discussion_comment_url"
+ ]
+ },
+ "secret-scanning-location-pull-request-title": {
+ "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.",
+ "type": "object",
+ "properties": {
+ "pull_request_title_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the pull request where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846"
+ }
+ },
+ "required": [
+ "pull_request_title_url"
+ ]
+ },
+ "secret-scanning-location-pull-request-body": {
+ "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.",
+ "type": "object",
+ "properties": {
+ "pull_request_body_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the pull request where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846"
+ }
+ },
+ "required": [
+ "pull_request_body_url"
+ ]
+ },
+ "secret-scanning-location-pull-request-comment": {
+ "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.",
+ "type": "object",
+ "properties": {
+ "pull_request_comment_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the pull request comment where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451"
+ }
+ },
+ "required": [
+ "pull_request_comment_url"
+ ]
+ },
+ "secret-scanning-location-pull-request-review": {
+ "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.",
+ "type": "object",
+ "properties": {
+ "pull_request_review_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the pull request review where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80"
+ }
+ },
+ "required": [
+ "pull_request_review_url"
+ ]
+ },
+ "secret-scanning-location-pull-request-review-comment": {
+ "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.",
+ "type": "object",
+ "properties": {
+ "pull_request_review_comment_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get the pull request review comment where the secret was detected.",
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12"
+ }
+ },
+ "required": [
+ "pull_request_review_comment_url"
+ ]
+ },
+ "secret-scanning-location": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "commit",
+ "issue_title",
+ "issue_body",
+ "issue_comment",
+ "discussion_title",
+ "discussion_body",
+ "discussion_comment",
+ "pull_request_title",
+ "pull_request_body",
+ "pull_request_comment",
+ "pull_request_review",
+ "pull_request_review_comment"
+ ],
+ "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.",
+ "example": "commit"
+ },
+ "details": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-commit"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-issue-title"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-issue-body"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-issue-comment"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-discussion-title"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-discussion-body"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-discussion-comment"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-pull-request-title"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-pull-request-body"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-pull-request-review"
+ },
+ {
+ "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "details"
+ ]
+ },
+ "repository-advisory-create": {
+ "type": "object",
+ "properties": {
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of what the advisory impacts.",
+ "maxLength": 65535
+ },
+ "cve_id": {
+ "type": "string",
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID.",
+ "nullable": true
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "description": "A product affected by the vulnerability detailed in a repository security advisory.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "ecosystem"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "The range of the package versions affected by the vulnerability.",
+ "nullable": true
+ },
+ "patched_versions": {
+ "type": "string",
+ "description": "The package version(s) that resolve the vulnerability.",
+ "nullable": true
+ },
+ "vulnerable_functions": {
+ "type": "array",
+ "description": "The functions in the package that are affected.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "cwe_ids": {
+ "type": "array",
+ "description": "A list of Common Weakness Enumeration (CWE) IDs.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "credits": {
+ "type": "array",
+ "description": "A list of users receiving credit for their participation in the security advisory.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The username of the user credited."
+ },
+ "type": {
+ "$ref": "#/components/schemas/security-advisory-credit-types"
+ }
+ },
+ "required": [
+ "login",
+ "type"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
+ "nullable": true,
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low"
+ ]
+ },
+ "cvss_vector_string": {
+ "type": "string",
+ "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
+ "nullable": true
+ },
+ "start_private_fork": {
+ "type": "boolean",
+ "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.",
+ "default": false
+ }
+ },
+ "required": [
+ "summary",
+ "description",
+ "vulnerabilities"
+ ],
+ "additionalProperties": false
+ },
+ "private-vulnerability-report-create": {
+ "type": "object",
+ "properties": {
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of what the advisory impacts.",
+ "maxLength": 65535
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "description": "An array of products affected by the vulnerability detailed in a repository security advisory.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "ecosystem"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "The range of the package versions affected by the vulnerability.",
+ "nullable": true
+ },
+ "patched_versions": {
+ "type": "string",
+ "description": "The package version(s) that resolve the vulnerability.",
+ "nullable": true
+ },
+ "vulnerable_functions": {
+ "type": "array",
+ "description": "The functions in the package that are affected.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "cwe_ids": {
+ "type": "array",
+ "description": "A list of Common Weakness Enumeration (CWE) IDs.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
+ "nullable": true,
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low"
+ ]
+ },
+ "cvss_vector_string": {
+ "type": "string",
+ "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
+ "nullable": true
+ },
+ "start_private_fork": {
+ "type": "boolean",
+ "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.",
+ "default": false
+ }
+ },
+ "required": [
+ "summary",
+ "description"
+ ],
+ "additionalProperties": false
+ },
+ "repository-advisory-update": {
+ "type": "object",
+ "properties": {
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of what the advisory impacts.",
+ "maxLength": 65535
+ },
+ "cve_id": {
+ "type": "string",
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID.",
+ "nullable": true
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "description": "A product affected by the vulnerability detailed in a repository security advisory.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "$ref": "#/components/schemas/security-advisory-ecosystems"
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique package name within its ecosystem.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "ecosystem"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": "string",
+ "description": "The range of the package versions affected by the vulnerability.",
+ "nullable": true
+ },
+ "patched_versions": {
+ "type": "string",
+ "description": "The package version(s) that resolve the vulnerability.",
+ "nullable": true
+ },
+ "vulnerable_functions": {
+ "type": "array",
+ "description": "The functions in the package that are affected.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "cwe_ids": {
+ "type": "array",
+ "description": "A list of Common Weakness Enumeration (CWE) IDs.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "credits": {
+ "type": "array",
+ "description": "A list of users receiving credit for their participation in the security advisory.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The username of the user credited."
+ },
+ "type": {
+ "$ref": "#/components/schemas/security-advisory-credit-types"
+ }
+ },
+ "required": [
+ "login",
+ "type"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "severity": {
+ "type": "string",
+ "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
+ "nullable": true,
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low"
+ ]
+ },
+ "cvss_vector_string": {
+ "type": "string",
+ "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
+ "nullable": true
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the advisory.",
+ "enum": [
+ "published",
+ "closed",
+ "draft"
+ ]
+ },
+ "collaborating_users": {
+ "type": "array",
+ "description": "A list of usernames who have been granted write access to the advisory.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "collaborating_teams": {
+ "type": "array",
+ "description": "A list of team slugs which have been granted write access to the advisory.",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "stargazer": {
+ "title": "Stargazer",
+ "description": "Stargazer",
+ "type": "object",
+ "properties": {
+ "starred_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "starred_at",
+ "user"
+ ]
+ },
+ "code-frequency-stat": {
+ "title": "Code Frequency Stat",
+ "description": "Code Frequency Stat",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "commit-activity": {
+ "title": "Commit Activity",
+ "description": "Commit Activity",
+ "type": "object",
+ "properties": {
+ "days": {
+ "type": "array",
+ "example": [
+ 0,
+ 3,
+ 26,
+ 20,
+ 39,
+ 1,
+ 0
+ ],
+ "items": {
+ "type": "integer"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "example": 89
+ },
+ "week": {
+ "type": "integer",
+ "example": 1336280400
+ }
+ },
+ "required": [
+ "days",
+ "total",
+ "week"
+ ]
+ },
+ "contributor-activity": {
+ "title": "Contributor Activity",
+ "description": "Contributor Activity",
+ "type": "object",
+ "properties": {
+ "author": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "total": {
+ "type": "integer",
+ "example": 135
+ },
+ "weeks": {
+ "type": "array",
+ "example": [
+ {
+ "w": "1367712000",
+ "a": 6898,
+ "d": 77,
+ "c": 10
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "w": {
+ "type": "integer"
+ },
+ "a": {
+ "type": "integer"
+ },
+ "d": {
+ "type": "integer"
+ },
+ "c": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "author",
+ "total",
+ "weeks"
+ ]
+ },
+ "participation-stats": {
+ "title": "Participation Stats",
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "owner": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "all",
+ "owner"
+ ]
+ },
+ "repository-subscription": {
+ "title": "Repository Invitation",
+ "description": "Repository invitations let you manage who you collaborate with.",
+ "type": "object",
+ "properties": {
+ "subscribed": {
+ "description": "Determines if notifications should be received from this repository.",
+ "type": "boolean",
+ "example": true
+ },
+ "ignored": {
+ "description": "Determines if all notifications should be blocked from this repository.",
+ "type": "boolean"
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-10-06T21:34:12Z"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/subscription"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ }
+ },
+ "required": [
+ "created_at",
+ "ignored",
+ "reason",
+ "subscribed",
+ "url",
+ "repository_url"
+ ]
+ },
+ "tag": {
+ "title": "Tag",
+ "description": "Tag",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "v0.1"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "zipball_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/zipball/v0.1"
+ },
+ "tarball_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World/tarball/v0.1"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "node_id",
+ "commit",
+ "zipball_url",
+ "tarball_url"
+ ]
+ },
+ "tag-protection": {
+ "title": "Tag protection",
+ "description": "Tag protection",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 2
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "pattern": {
+ "type": "string",
+ "example": "v1.*"
+ }
+ },
+ "required": [
+ "pattern"
+ ]
+ },
+ "topic": {
+ "title": "Topic",
+ "description": "A topic aggregates entities that are related to a subject.",
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "traffic": {
+ "title": "Traffic",
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uniques": {
+ "type": "integer"
+ },
+ "count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "timestamp",
+ "uniques",
+ "count"
+ ]
+ },
+ "clone-traffic": {
+ "title": "Clone Traffic",
+ "description": "Clone Traffic",
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "example": 173
+ },
+ "uniques": {
+ "type": "integer",
+ "example": 128
+ },
+ "clones": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/traffic"
+ }
+ }
+ },
+ "required": [
+ "uniques",
+ "count",
+ "clones"
+ ]
+ },
+ "content-traffic": {
+ "title": "Content Traffic",
+ "description": "Content Traffic",
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "example": "/github/hubot"
+ },
+ "title": {
+ "type": "string",
+ "example": "github/hubot: A customizable life embetterment robot."
+ },
+ "count": {
+ "type": "integer",
+ "example": 3542
+ },
+ "uniques": {
+ "type": "integer",
+ "example": 2225
+ }
+ },
+ "required": [
+ "path",
+ "title",
+ "uniques",
+ "count"
+ ]
+ },
+ "referrer-traffic": {
+ "title": "Referrer Traffic",
+ "description": "Referrer Traffic",
+ "type": "object",
+ "properties": {
+ "referrer": {
+ "type": "string",
+ "example": "Google"
+ },
+ "count": {
+ "type": "integer",
+ "example": 4
+ },
+ "uniques": {
+ "type": "integer",
+ "example": 3
+ }
+ },
+ "required": [
+ "referrer",
+ "uniques",
+ "count"
+ ]
+ },
+ "view-traffic": {
+ "title": "View Traffic",
+ "description": "View Traffic",
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "example": 14850
+ },
+ "uniques": {
+ "type": "integer",
+ "example": 3782
+ },
+ "views": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/traffic"
+ }
+ }
+ },
+ "required": [
+ "uniques",
+ "count",
+ "views"
+ ]
+ },
+ "search-result-text-matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "nullable": true,
+ "type": "string"
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
+ "type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "code-search-result-item": {
+ "title": "Code Search Result Item",
+ "description": "Code Search Result Item",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "score": {
+ "type": "number"
+ },
+ "file_size": {
+ "type": "integer"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "last_modified_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "line_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "73..77",
+ "77..78"
+ ]
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ }
+ },
+ "required": [
+ "score",
+ "name",
+ "path",
+ "sha",
+ "git_url",
+ "html_url",
+ "url",
+ "repository"
+ ]
+ },
+ "commit-search-result-item": {
+ "title": "Commit Search Result Item",
+ "description": "Commit Search Result Item",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "name",
+ "email",
+ "date"
+ ]
+ },
+ "committer": {
+ "$ref": "#/components/schemas/nullable-git-user"
+ },
+ "comment_count": {
+ "type": "integer"
+ },
+ "message": {
+ "type": "string"
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "verification": {
+ "$ref": "#/components/schemas/verification"
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "committer": {
+ "$ref": "#/components/schemas/nullable-git-user"
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "score": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ }
+ },
+ "required": [
+ "sha",
+ "node_id",
+ "url",
+ "html_url",
+ "author",
+ "committer",
+ "parents",
+ "comments_url",
+ "commit",
+ "repository",
+ "score"
+ ]
+ },
+ "issue-search-result-item": {
+ "title": "Issue Search Result Item",
+ "description": "Issue Search Result Item",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "title": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "nullable": true
+ },
+ "user": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "state": {
+ "type": "string"
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/nullable-milestone"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "merged_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "diff_url",
+ "html_url",
+ "patch_url",
+ "url"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "author_association": {
+ "$ref": "#/components/schemas/author-association"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "$ref": "#/components/schemas/reaction-rollup"
+ }
+ },
+ "required": [
+ "assignee",
+ "closed_at",
+ "comments",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "labels",
+ "labels_url",
+ "milestone",
+ "number",
+ "repository_url",
+ "state",
+ "locked",
+ "title",
+ "url",
+ "user",
+ "author_association",
+ "created_at",
+ "updated_at",
+ "score"
+ ]
+ },
+ "label-search-result-item": {
+ "title": "Label Search Result Item",
+ "description": "Label Search Result Item",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string"
+ },
+ "color": {
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "score": {
+ "type": "number"
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description",
+ "score"
+ ]
+ },
+ "repo-search-result-item": {
+ "title": "Repo Search Result Item",
+ "description": "Repo Search Result Item",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "archive_url": {
+ "type": "string"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "type": "string"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "allow_auto_merge": {
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at",
+ "score"
+ ]
+ },
+ "topic-search-result-item": {
+ "title": "Topic Search Result Item",
+ "description": "Topic Search Result Item",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "display_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "short_description": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "released": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "featured": {
+ "type": "boolean"
+ },
+ "curated": {
+ "type": "boolean"
+ },
+ "score": {
+ "type": "number"
+ },
+ "repository_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "logo_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ },
+ "related": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "aliases": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "name",
+ "display_name",
+ "short_description",
+ "description",
+ "created_by",
+ "released",
+ "created_at",
+ "updated_at",
+ "featured",
+ "curated",
+ "score"
+ ]
+ },
+ "user-search-result-item": {
+ "title": "User Search Result Item",
+ "description": "User Search Result Item",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "bio": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "nullable": true
+ },
+ "location": {
+ "type": "string",
+ "nullable": true
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "hireable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "text_matches": {
+ "$ref": "#/components/schemas/search-result-text-matches"
+ },
+ "blog": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "score"
+ ]
+ },
+ "private-user": {
+ "title": "Private User",
+ "description": "Private User",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "example": "monalisa octocat",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub",
+ "nullable": true
+ },
+ "blog": {
+ "type": "string",
+ "example": "https://github.com/blog",
+ "nullable": true
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com",
+ "nullable": true
+ },
+ "hireable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "bio": {
+ "type": "string",
+ "example": "There once was...",
+ "nullable": true
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "monalisa",
+ "nullable": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8
+ },
+ "two_factor_authentication": {
+ "type": "boolean",
+ "example": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "collaborators": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "collaborators",
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "business_plus": {
+ "type": "boolean"
+ },
+ "ldap_dn": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "bio",
+ "blog",
+ "company",
+ "email",
+ "followers",
+ "following",
+ "hireable",
+ "location",
+ "name",
+ "public_gists",
+ "public_repos",
+ "created_at",
+ "updated_at",
+ "collaborators",
+ "disk_usage",
+ "owned_private_repos",
+ "private_gists",
+ "total_private_repos",
+ "two_factor_authentication"
+ ]
+ },
+ "codespaces-secret": {
+ "title": "Codespaces Secret",
+ "description": "Secrets for a GitHub Codespace.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the secret",
+ "example": "SECRET_NAME",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "description": "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "visibility": {
+ "description": "The type of repositories in the organization that the secret is visible to",
+ "enum": [
+ "all",
+ "private",
+ "selected"
+ ],
+ "type": "string"
+ },
+ "selected_repositories_url": {
+ "description": "The API URL at which the list of repositories this secret is visible to can be retrieved",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/user/secrets/SECRET_NAME/repositories"
+ }
+ },
+ "required": [
+ "name",
+ "created_at",
+ "updated_at",
+ "visibility",
+ "selected_repositories_url"
+ ]
+ },
+ "codespaces-user-public-key": {
+ "title": "CodespacesUserPublicKey",
+ "description": "The public key used for setting user Codespaces' Secrets.",
+ "type": "object",
+ "properties": {
+ "key_id": {
+ "description": "The identifier for the key.",
+ "type": "string",
+ "example": "1234567"
+ },
+ "key": {
+ "description": "The Base64 encoded public key.",
+ "type": "string",
+ "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
+ }
+ },
+ "required": [
+ "key_id",
+ "key"
+ ]
+ },
+ "codespace-export-details": {
+ "type": "object",
+ "title": "Fetches information about an export of a codespace.",
+ "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "State of the latest export",
+ "nullable": true,
+ "example": "succeeded | failed | in_progress"
+ },
+ "completed_at": {
+ "description": "Completion time of the last export operation",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true,
+ "example": "2021-01-01T19:01:12Z"
+ },
+ "branch": {
+ "type": "string",
+ "description": "Name of the exported branch",
+ "nullable": true,
+ "example": "codespace-monalisa-octocat-hello-world-g4wpq6h95q"
+ },
+ "sha": {
+ "type": "string",
+ "description": "Git commit SHA of the exported branch",
+ "nullable": true,
+ "example": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2"
+ },
+ "id": {
+ "type": "string",
+ "description": "Id for the export details",
+ "example": "latest"
+ },
+ "export_url": {
+ "type": "string",
+ "description": "Url for fetching export details",
+ "example": "https://api.github.com/user/codespaces/:name/exports/latest"
+ },
+ "html_url": {
+ "type": "string",
+ "nullable": true,
+ "description": "Web url for the exported branch",
+ "example": "https://github.com/octocat/hello-world/tree/:branch"
+ }
+ }
+ },
+ "codespace-with-full-repository": {
+ "type": "object",
+ "title": "Codespace",
+ "description": "A codespace.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "name": {
+ "description": "Automatically generated name of this codespace.",
+ "type": "string",
+ "example": "monalisa-octocat-hello-world-g4wpq6h95q"
+ },
+ "display_name": {
+ "description": "Display name for this codespace.",
+ "type": "string",
+ "example": "bookish space pancake",
+ "nullable": true
+ },
+ "environment_id": {
+ "description": "UUID identifying this codespace's environment.",
+ "type": "string",
+ "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "nullable": true
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "billable_owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "machine": {
+ "$ref": "#/components/schemas/nullable-codespace-machine"
+ },
+ "devcontainer_path": {
+ "description": "Path to devcontainer.json from repo root used to create Codespace.",
+ "type": "string",
+ "example": ".devcontainer/example/devcontainer.json",
+ "nullable": true
+ },
+ "prebuild": {
+ "description": "Whether the codespace was created from a prebuild.",
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "last_used_at": {
+ "description": "Last known time this codespace was started.",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z"
+ },
+ "state": {
+ "description": "State of this codespace.",
+ "enum": [
+ "Unknown",
+ "Created",
+ "Queued",
+ "Provisioning",
+ "Available",
+ "Awaiting",
+ "Unavailable",
+ "Deleted",
+ "Moved",
+ "Shutdown",
+ "Archived",
+ "Starting",
+ "ShuttingDown",
+ "Failed",
+ "Exporting",
+ "Updating",
+ "Rebuilding"
+ ],
+ "example": "Available",
+ "type": "string"
+ },
+ "url": {
+ "description": "API URL for this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "git_status": {
+ "description": "Details about the codespace's git repository.",
+ "type": "object",
+ "properties": {
+ "ahead": {
+ "description": "The number of commits the local repository is ahead of the remote.",
+ "type": "integer",
+ "example": 0
+ },
+ "behind": {
+ "description": "The number of commits the local repository is behind the remote.",
+ "type": "integer",
+ "example": 0
+ },
+ "has_unpushed_changes": {
+ "description": "Whether the local repository has unpushed changes.",
+ "type": "boolean"
+ },
+ "has_uncommitted_changes": {
+ "description": "Whether the local repository has uncommitted changes.",
+ "type": "boolean"
+ },
+ "ref": {
+ "description": "The current branch (or SHA if in detached HEAD state) of the local repository.",
+ "type": "string",
+ "example": "main"
+ }
+ }
+ },
+ "location": {
+ "description": "The initally assigned location of a new codespace.",
+ "enum": [
+ "EastUs",
+ "SouthEastAsia",
+ "WestEurope",
+ "WestUs2"
+ ],
+ "example": "WestUs2",
+ "type": "string"
+ },
+ "idle_timeout_minutes": {
+ "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.",
+ "type": "integer",
+ "example": 60,
+ "nullable": true
+ },
+ "web_url": {
+ "description": "URL to access this codespace on the web.",
+ "type": "string",
+ "format": "uri"
+ },
+ "machines_url": {
+ "description": "API URL to access available alternate machine types for this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "start_url": {
+ "description": "API URL to start this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "stop_url": {
+ "description": "API URL to stop this codespace.",
+ "type": "string",
+ "format": "uri"
+ },
+ "publish_url": {
+ "description": "API URL to publish this codespace to a new repository.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "pulls_url": {
+ "description": "API URL for the Pull Request associated with this codespace, if any.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "recent_folders": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "runtime_constraints": {
+ "type": "object",
+ "properties": {
+ "allowed_port_privacy_settings": {
+ "description": "The privacy settings a user can select from when forwarding a port.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "pending_operation": {
+ "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.",
+ "type": "boolean",
+ "nullable": true
+ },
+ "pending_operation_disabled_reason": {
+ "description": "Text to show user when codespace is disabled by a pending operation",
+ "type": "string",
+ "nullable": true
+ },
+ "idle_timeout_notice": {
+ "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
+ "type": "string",
+ "nullable": true
+ },
+ "retention_period_minutes": {
+ "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
+ "type": "integer",
+ "example": 60,
+ "nullable": true
+ },
+ "retention_expires_at": {
+ "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T20:01:12Z",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "environment_id",
+ "owner",
+ "billable_owner",
+ "repository",
+ "machine",
+ "prebuild",
+ "created_at",
+ "updated_at",
+ "last_used_at",
+ "state",
+ "url",
+ "git_status",
+ "location",
+ "idle_timeout_minutes",
+ "web_url",
+ "machines_url",
+ "start_url",
+ "stop_url",
+ "pulls_url",
+ "recent_folders"
+ ]
+ },
+ "email": {
+ "title": "Email",
+ "description": "Email",
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "primary": {
+ "type": "boolean",
+ "example": true
+ },
+ "verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "visibility": {
+ "type": "string",
+ "example": "public",
+ "nullable": true
+ }
+ },
+ "required": [
+ "email",
+ "primary",
+ "verified",
+ "visibility"
+ ]
+ },
+ "gpg-key": {
+ "title": "GPG Key",
+ "description": "A unique encryption key",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "name": {
+ "type": "string",
+ "example": "Octocat's GPG Key",
+ "nullable": true
+ },
+ "primary_key_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "key_id": {
+ "type": "string",
+ "example": "3262EFF25BA0D270"
+ },
+ "public_key": {
+ "type": "string",
+ "example": "xsBNBFayYZ..."
+ },
+ "emails": {
+ "type": "array",
+ "example": [
+ {
+ "email": "octocat@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "example": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": null,
+ "revoked": false
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "primary_key_id": {
+ "type": "integer"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "public_key": {
+ "type": "string"
+ },
+ "emails": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "can_sign": {
+ "type": "boolean"
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ },
+ "revoked": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "can_sign": {
+ "type": "boolean",
+ "example": true
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean",
+ "example": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-03-24T11:31:04-06:00"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "revoked": {
+ "type": "boolean",
+ "example": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "primary_key_id",
+ "key_id",
+ "raw_key",
+ "public_key",
+ "created_at",
+ "expires_at",
+ "can_sign",
+ "can_encrypt_comms",
+ "can_encrypt_storage",
+ "can_certify",
+ "emails",
+ "subkeys",
+ "revoked"
+ ]
+ },
+ "key": {
+ "title": "Key",
+ "description": "Key",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "verified": {
+ "type": "boolean"
+ },
+ "read_only": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "key",
+ "id",
+ "url",
+ "title",
+ "created_at",
+ "verified",
+ "read_only"
+ ]
+ },
+ "marketplace-account": {
+ "title": "Marketplace Account",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "type": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "type",
+ "login"
+ ]
+ },
+ "user-marketplace-purchase": {
+ "title": "User Marketplace Purchase",
+ "description": "User Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "billing_cycle": {
+ "type": "string",
+ "example": "monthly"
+ },
+ "next_billing_date": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-11-11T00:00:00Z",
+ "nullable": true
+ },
+ "unit_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean",
+ "example": true
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-11-11T00:00:00Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2017-11-02T01:12:12Z",
+ "nullable": true
+ },
+ "account": {
+ "$ref": "#/components/schemas/marketplace-account"
+ },
+ "plan": {
+ "$ref": "#/components/schemas/marketplace-listing-plan"
+ }
+ },
+ "required": [
+ "billing_cycle",
+ "next_billing_date",
+ "unit_count",
+ "updated_at",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "account",
+ "plan"
+ ]
+ },
+ "social-account": {
+ "title": "Social account",
+ "description": "Social media account",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "example": "linkedin"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://www.linkedin.com/company/github/"
+ }
+ },
+ "required": [
+ "provider",
+ "url"
+ ]
+ },
+ "ssh-signing-key": {
+ "title": "SSH Signing Key",
+ "description": "A public SSH key used to sign Git commits",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "title": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "key",
+ "id",
+ "title",
+ "created_at"
+ ]
+ },
+ "starred-repository": {
+ "title": "Starred Repository",
+ "description": "Starred Repository",
+ "type": "object",
+ "properties": {
+ "starred_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "repo": {
+ "$ref": "#/components/schemas/repository"
+ }
+ },
+ "required": [
+ "starred_at",
+ "repo"
+ ]
+ },
+ "hovercard": {
+ "title": "Hovercard",
+ "description": "Hovercard",
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "octicon": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "message",
+ "octicon"
+ ]
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ]
+ },
+ "key-simple": {
+ "title": "Key Simple",
+ "description": "Key Simple",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "id"
+ ]
+ },
+ "enterprise-webhooks": {
+ "title": "Enterprise",
+ "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"\n",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the enterprise.",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/enterprises/octo-business"
+ },
+ "website_url": {
+ "description": "The enterprise's website URL.",
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the enterprise",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the enterprise.",
+ "type": "string",
+ "example": "Octo Business"
+ },
+ "slug": {
+ "description": "The slug url identifier for the enterprise.",
+ "type": "string",
+ "example": "octo-business"
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time",
+ "example": "2019-01-26T19:01:12Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time",
+ "example": "2019-01-26T19:14:43Z"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "slug",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "avatar_url"
+ ]
+ },
+ "simple-installation": {
+ "title": "Simple Installation",
+ "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "description": "The global node ID of the installation.",
+ "type": "string",
+ "example": "MDQ6VXNlcjU4MzIzMQ=="
+ }
+ },
+ "required": [
+ "id",
+ "node_id"
+ ]
+ },
+ "organization-simple-webhooks": {
+ "title": "Organization Simple",
+ "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
+ },
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
+ },
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
+ },
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description"
+ ]
+ },
+ "repository-webhooks": {
+ "title": "Repository",
+ "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "template_repository": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string"
+ },
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_auto_merge": {
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean"
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ }
+ }
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_update_branch": {
+ "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:42Z\""
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean",
+ "description": "Whether anonymous git access is enabled for this repository"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "simple-user-webhooks": {
+ "title": "Simple User",
+ "description": "The GitHub user that triggered the event. This property is included in every webhook payload.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "simple-check-suite": {
+ "description": "A suite of checks performed on the code of a given code change",
+ "type": "object",
+ "properties": {
+ "after": {
+ "example": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "type": "string",
+ "nullable": true
+ },
+ "app": {
+ "$ref": "#/components/schemas/integration"
+ },
+ "before": {
+ "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "example": "neutral",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required",
+ "stale",
+ "startup_failure"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "head_branch": {
+ "example": "master",
+ "type": "string",
+ "nullable": true
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that is being checked.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "id": {
+ "example": 5,
+ "type": "integer"
+ },
+ "node_id": {
+ "example": "MDEwOkNoZWNrU3VpdGU1",
+ "type": "string"
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-minimal"
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/minimal-repository"
+ },
+ "status": {
+ "example": "completed",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "pending",
+ "waiting"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "example": "https://api.github.com/repos/github/hello-world/check-suites/5",
+ "type": "string"
+ }
+ }
+ },
+ "check-run-with-simple-check-suite": {
+ "title": "CheckRun",
+ "description": "A check performed on the code of a given code change",
+ "type": "object",
+ "properties": {
+ "app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "check_suite": {
+ "$ref": "#/components/schemas/simple-check-suite"
+ },
+ "completed_at": {
+ "example": "2018-05-04T01:14:52Z",
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "conclusion": {
+ "example": "neutral",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "waiting",
+ "pending",
+ "startup_failure",
+ "stale",
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ]
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment-simple"
+ },
+ "details_url": {
+ "example": "https://example.com",
+ "type": "string"
+ },
+ "external_id": {
+ "example": "42",
+ "type": "string"
+ },
+ "head_sha": {
+ "description": "The SHA of the commit that is being checked.",
+ "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
+ "type": "string"
+ },
+ "html_url": {
+ "example": "https://github.com/github/hello-world/runs/4",
+ "type": "string"
+ },
+ "id": {
+ "description": "The id of the check.",
+ "example": 21,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the check.",
+ "example": "test-coverage",
+ "type": "string"
+ },
+ "node_id": {
+ "example": "MDg6Q2hlY2tSdW40",
+ "type": "string"
+ },
+ "output": {
+ "type": "object",
+ "properties": {
+ "annotations_count": {
+ "type": "integer"
+ },
+ "annotations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "summary": {
+ "type": "string",
+ "nullable": true
+ },
+ "text": {
+ "type": "string",
+ "nullable": true
+ },
+ "title": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "title",
+ "summary",
+ "text",
+ "annotations_count",
+ "annotations_url"
+ ]
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request-minimal"
+ }
+ },
+ "started_at": {
+ "example": "2018-05-04T01:14:52Z",
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "description": "The phase of the lifecycle that the check is currently in.",
+ "example": "queued",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "pending"
+ ]
+ },
+ "url": {
+ "example": "https://api.github.com/repos/github/hello-world/check-runs/4",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_sha",
+ "name",
+ "url",
+ "html_url",
+ "details_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "external_id",
+ "check_suite",
+ "output",
+ "app",
+ "pull_requests"
+ ]
+ },
+ "discussion": {
+ "title": "Discussion",
+ "description": "A Discussion in a repository.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "answer_chosen_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "answer_chosen_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "answer_html_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "category": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string"
+ },
+ "emoji": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_answerable": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "emoji",
+ "name",
+ "description",
+ "created_at",
+ "updated_at",
+ "slug",
+ "is_answerable"
+ ]
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.",
+ "enum": [
+ "open",
+ "closed",
+ "locked",
+ "converting",
+ "transferring"
+ ]
+ },
+ "state_reason": {
+ "description": "The reason for the current state",
+ "example": "resolved",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "outdated",
+ "duplicate",
+ "reopened"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "repository_url",
+ "category",
+ "answer_html_url",
+ "answer_chosen_at",
+ "answer_chosen_by",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "state",
+ "state_reason",
+ "locked",
+ "comments",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "active_lock_reason",
+ "body"
+ ]
+ },
+ "merge-group": {
+ "type": "object",
+ "title": "Merge Group",
+ "description": "A group of pull requests that the merge queue has grouped together to be merged.\n",
+ "properties": {
+ "head_sha": {
+ "description": "The SHA of the merge group.",
+ "type": "string"
+ },
+ "head_ref": {
+ "description": "The full ref of the merge group.",
+ "type": "string"
+ },
+ "base_sha": {
+ "description": "The SHA of the merge group's parent commit.",
+ "type": "string"
+ },
+ "base_ref": {
+ "description": "The full ref of the branch the merge group will be merged into.",
+ "type": "string"
+ },
+ "head_commit": {
+ "$ref": "#/components/schemas/simple-commit"
+ }
+ },
+ "required": [
+ "head_sha",
+ "head_ref",
+ "base_sha",
+ "base_ref",
+ "head_commit"
+ ]
+ },
+ "nullable-repository-webhooks": {
+ "title": "Repository",
+ "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "$ref": "#/components/schemas/nullable-license-simple"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "template_repository": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string"
+ },
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_auto_merge": {
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean"
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ }
+ }
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_update_branch": {
+ "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "use_squash_pr_title_as_default": {
+ "type": "boolean",
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "default": false,
+ "deprecated": true
+ },
+ "squash_merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ],
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
+ },
+ "squash_merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ],
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
+ },
+ "merge_commit_title": {
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ],
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
+ },
+ "merge_commit_message": {
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ],
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:42Z\""
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean",
+ "description": "Whether anonymous git access is enabled for this repository"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ],
+ "nullable": true
+ },
+ "personal-access-token-request": {
+ "title": "Personal Access Token Request",
+ "description": "Details of a Personal Access Token Request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls."
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "permissions_added": {
+ "type": "object",
+ "description": "New requested permissions, categorized by type of permission.",
+ "properties": {
+ "organization": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repository": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "other": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "permissions_upgraded": {
+ "type": "object",
+ "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.",
+ "properties": {
+ "organization": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repository": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "other": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "permissions_result": {
+ "type": "object",
+ "description": "Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`.",
+ "properties": {
+ "organization": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repository": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "other": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "repository_selection": {
+ "type": "string",
+ "description": "Type of repository selection requested.",
+ "enum": [
+ "none",
+ "all",
+ "subset"
+ ]
+ },
+ "repository_count": {
+ "description": "The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`.",
+ "type": "integer",
+ "nullable": true
+ },
+ "repositories": {
+ "type": "array",
+ "description": "An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ },
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "description": "Date and time when the request for access was created."
+ },
+ "token_expired": {
+ "type": "boolean",
+ "description": "Whether the associated fine-grained personal access token has expired."
+ },
+ "token_expires_at": {
+ "type": "string",
+ "description": "Date and time when the associated fine-grained personal access token expires.",
+ "nullable": true
+ },
+ "token_last_used_at": {
+ "type": "string",
+ "description": "Date and time when the associated fine-grained personal access token was last used for authentication.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "owner",
+ "permissions_added",
+ "permissions_upgraded",
+ "permissions_result",
+ "repository_selection",
+ "repository_count",
+ "repositories",
+ "created_at",
+ "token_expired",
+ "token_expires_at",
+ "token_last_used_at"
+ ]
+ },
+ "projects-v2": {
+ "title": "Projects v2 Project",
+ "description": "A projects v2 project",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "title": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "closed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "short_description": {
+ "type": "string",
+ "nullable": true
+ },
+ "deleted_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z",
+ "nullable": true
+ },
+ "deleted_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "creator",
+ "title",
+ "description",
+ "public",
+ "closed_at",
+ "created_at",
+ "updated_at",
+ "number",
+ "short_description",
+ "deleted_at",
+ "deleted_by"
+ ]
+ },
+ "projects-v2-item-content-type": {
+ "title": "Projects v2 Item Content Type",
+ "description": "The type of content tracked in a project item",
+ "type": "string",
+ "enum": [
+ "Issue",
+ "PullRequest",
+ "DraftIssue"
+ ]
+ },
+ "projects-v2-item": {
+ "title": "Projects v2 Item",
+ "description": "An item belonging to a project",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "project_node_id": {
+ "type": "string"
+ },
+ "content_node_id": {
+ "type": "string"
+ },
+ "content_type": {
+ "$ref": "#/components/schemas/projects-v2-item-content-type"
+ },
+ "creator": {
+ "$ref": "#/components/schemas/simple-user"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-04-28T12:00:00Z",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "content_node_id",
+ "content_type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "secret-scanning-alert-resolution-webhook": {
+ "type": "string",
+ "description": "The reason for resolving the alert.",
+ "nullable": true,
+ "enum": [
+ "false_positive",
+ "wont_fix",
+ "revoked",
+ "used_in_tests",
+ "pattern_deleted",
+ "pattern_edited"
+ ]
+ },
+ "secret-scanning-alert-webhook": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "$ref": "#/components/schemas/alert-number"
+ },
+ "created_at": {
+ "$ref": "#/components/schemas/alert-created-at"
+ },
+ "updated_at": {
+ "$ref": "#/components/schemas/nullable-alert-updated-at"
+ },
+ "url": {
+ "$ref": "#/components/schemas/alert-url"
+ },
+ "html_url": {
+ "$ref": "#/components/schemas/alert-html-url"
+ },
+ "locations_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The REST API URL of the code locations for this alert."
+ },
+ "resolution": {
+ "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook"
+ },
+ "resolved_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "resolved_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "resolution_comment": {
+ "type": "string",
+ "description": "An optional comment to resolve an alert.",
+ "nullable": true
+ },
+ "secret_type": {
+ "type": "string",
+ "description": "The type of secret that secret scanning detected."
+ },
+ "validity": {
+ "type": "string",
+ "description": "The token status as of the latest validity check.",
+ "enum": [
+ "active",
+ "inactive",
+ "unknown"
+ ]
+ },
+ "push_protection_bypassed": {
+ "type": "boolean",
+ "description": "Whether push protection was bypassed for the detected secret.",
+ "nullable": true
+ },
+ "push_protection_bypassed_by": {
+ "$ref": "#/components/schemas/nullable-simple-user"
+ },
+ "push_protection_bypassed_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ }
+ }
+ },
+ "webhook-branch-protection-configuration-disabled": {
+ "title": "branch protection configuration disabled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "disabled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-branch-protection-configuration-enabled": {
+ "title": "branch protection configuration enabled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "enabled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-branch-protection-rule-created": {
+ "title": "branch protection rule created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "rule": {
+ "title": "branch protection rule",
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
+ "type": "object",
+ "properties": {
+ "admin_enforced": {
+ "type": "boolean"
+ },
+ "allow_deletions_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "allow_force_pushes_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "authorized_actor_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "authorized_actors_only": {
+ "type": "boolean"
+ },
+ "authorized_dismissal_actors_only": {
+ "type": "boolean"
+ },
+ "create_protected": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismiss_stale_reviews_on_push": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "ignore_approvals_from_contributors": {
+ "type": "boolean"
+ },
+ "linear_history_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "merge_queue_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "pull_request_reviews_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "require_code_owner_review": {
+ "type": "boolean"
+ },
+ "require_last_push_approval": {
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
+ "type": "boolean"
+ },
+ "required_approving_review_count": {
+ "type": "integer"
+ },
+ "required_conversation_resolution_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_deployments_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_status_checks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "required_status_checks_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "signature_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "strict_required_status_checks_policy": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "name",
+ "created_at",
+ "updated_at",
+ "pull_request_reviews_enforcement_level",
+ "required_approving_review_count",
+ "dismiss_stale_reviews_on_push",
+ "require_code_owner_review",
+ "authorized_dismissal_actors_only",
+ "ignore_approvals_from_contributors",
+ "required_status_checks",
+ "required_status_checks_enforcement_level",
+ "strict_required_status_checks_policy",
+ "signature_requirement_enforcement_level",
+ "linear_history_requirement_enforcement_level",
+ "admin_enforced",
+ "allow_force_pushes_enforcement_level",
+ "allow_deletions_enforcement_level",
+ "merge_queue_enforcement_level",
+ "required_deployments_enforcement_level",
+ "required_conversation_resolution_level",
+ "authorized_actors_only",
+ "authorized_actor_names"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "rule",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-branch-protection-rule-deleted": {
+ "title": "branch protection rule deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "rule": {
+ "title": "branch protection rule",
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
+ "type": "object",
+ "properties": {
+ "admin_enforced": {
+ "type": "boolean"
+ },
+ "allow_deletions_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "allow_force_pushes_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "authorized_actor_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "authorized_actors_only": {
+ "type": "boolean"
+ },
+ "authorized_dismissal_actors_only": {
+ "type": "boolean"
+ },
+ "create_protected": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismiss_stale_reviews_on_push": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "ignore_approvals_from_contributors": {
+ "type": "boolean"
+ },
+ "linear_history_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "merge_queue_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "pull_request_reviews_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "require_code_owner_review": {
+ "type": "boolean"
+ },
+ "require_last_push_approval": {
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
+ "type": "boolean"
+ },
+ "required_approving_review_count": {
+ "type": "integer"
+ },
+ "required_conversation_resolution_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_deployments_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_status_checks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "required_status_checks_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "signature_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "strict_required_status_checks_policy": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "name",
+ "created_at",
+ "updated_at",
+ "pull_request_reviews_enforcement_level",
+ "required_approving_review_count",
+ "dismiss_stale_reviews_on_push",
+ "require_code_owner_review",
+ "authorized_dismissal_actors_only",
+ "ignore_approvals_from_contributors",
+ "required_status_checks",
+ "required_status_checks_enforcement_level",
+ "strict_required_status_checks_policy",
+ "signature_requirement_enforcement_level",
+ "linear_history_requirement_enforcement_level",
+ "admin_enforced",
+ "allow_force_pushes_enforcement_level",
+ "allow_deletions_enforcement_level",
+ "merge_queue_enforcement_level",
+ "required_deployments_enforcement_level",
+ "required_conversation_resolution_level",
+ "authorized_actors_only",
+ "authorized_actor_names"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "rule",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-branch-protection-rule-edited": {
+ "title": "branch protection rule edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "If the action was `edited`, the changes to the rule.",
+ "type": "object",
+ "properties": {
+ "admin_enforced": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "authorized_actor_names": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "authorized_actors_only": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "authorized_dismissal_actors_only": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "linear_history_requirement_enforcement_level": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "required_status_checks": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "required_status_checks_enforcement_level": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "rule": {
+ "title": "branch protection rule",
+ "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
+ "type": "object",
+ "properties": {
+ "admin_enforced": {
+ "type": "boolean"
+ },
+ "allow_deletions_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "allow_force_pushes_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "authorized_actor_names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "authorized_actors_only": {
+ "type": "boolean"
+ },
+ "authorized_dismissal_actors_only": {
+ "type": "boolean"
+ },
+ "create_protected": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismiss_stale_reviews_on_push": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "ignore_approvals_from_contributors": {
+ "type": "boolean"
+ },
+ "linear_history_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "merge_queue_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "pull_request_reviews_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "require_code_owner_review": {
+ "type": "boolean"
+ },
+ "require_last_push_approval": {
+ "description": "Whether the most recent push must be approved by someone other than the person who pushed it",
+ "type": "boolean"
+ },
+ "required_approving_review_count": {
+ "type": "integer"
+ },
+ "required_conversation_resolution_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_deployments_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "required_status_checks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "required_status_checks_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "signature_requirement_enforcement_level": {
+ "type": "string",
+ "enum": [
+ "off",
+ "non_admins",
+ "everyone"
+ ]
+ },
+ "strict_required_status_checks_policy": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "name",
+ "created_at",
+ "updated_at",
+ "pull_request_reviews_enforcement_level",
+ "required_approving_review_count",
+ "dismiss_stale_reviews_on_push",
+ "require_code_owner_review",
+ "authorized_dismissal_actors_only",
+ "ignore_approvals_from_contributors",
+ "required_status_checks",
+ "required_status_checks_enforcement_level",
+ "strict_required_status_checks_policy",
+ "signature_requirement_enforcement_level",
+ "linear_history_requirement_enforcement_level",
+ "admin_enforced",
+ "allow_force_pushes_enforcement_level",
+ "allow_deletions_enforcement_level",
+ "merge_queue_enforcement_level",
+ "required_deployments_enforcement_level",
+ "required_conversation_resolution_level",
+ "authorized_actors_only",
+ "authorized_actor_names"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "rule",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-run-completed": {
+ "title": "Check Run Completed Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "completed"
+ ]
+ },
+ "check_run": {
+ "$ref": "#/components/schemas/check-run-with-simple-check-suite"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "check_run",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-run-completed-form-encoded": {
+ "title": "Check Run Completed Event",
+ "description": "The check_run.completed webhook encoded with URL encoding",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-check-run-created": {
+ "title": "Check Run Created Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "check_run": {
+ "$ref": "#/components/schemas/check-run-with-simple-check-suite"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "check_run",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-run-created-form-encoded": {
+ "title": "Check Run Created Event",
+ "description": "The check_run.created webhook encoded with URL encoding",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-check-run-requested-action": {
+ "title": "Check Run Requested Action Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "requested_action"
+ ]
+ },
+ "check_run": {
+ "$ref": "#/components/schemas/check-run-with-simple-check-suite"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requested_action": {
+ "description": "The action requested by the user.",
+ "type": "object",
+ "properties": {
+ "identifier": {
+ "description": "The integrator reference of the action requested by the user.",
+ "type": "string"
+ }
+ }
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "check_run",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-run-requested-action-form-encoded": {
+ "title": "Check Run Requested Action Event",
+ "description": "The check_run.requested_action webhook encoded with URL encoding",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-check-run-rerequested": {
+ "title": "Check Run Re-Requested Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "rerequested"
+ ]
+ },
+ "check_run": {
+ "$ref": "#/components/schemas/check-run-with-simple-check-suite"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "check_run",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-run-rerequested-form-encoded": {
+ "title": "Check Run Re-Requested Event",
+ "description": "The check_run.rerequested webhook encoded with URL encoding",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-check-suite-completed": {
+ "title": "check_suite completed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "completed"
+ ]
+ },
+ "check_suite": {
+ "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).",
+ "type": "object",
+ "properties": {
+ "after": {
+ "type": "string",
+ "nullable": true
+ },
+ "app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "merge_group",
+ "pull_request_review_thread",
+ "workflow_job",
+ "merge_queue_entry",
+ "security_and_analysis",
+ "projects_v2_item",
+ "secret_scanning_alert_location"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "before": {
+ "type": "string",
+ "nullable": true
+ },
+ "check_runs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null,
+ "skipped",
+ "startup_failure"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "head_branch": {
+ "description": "The head branch name the changes are on.",
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that is being checked.",
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "latest_check_runs_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_requests": {
+ "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "rerequestable": {
+ "type": "boolean"
+ },
+ "runs_rerequestable": {
+ "type": "boolean"
+ },
+ "status": {
+ "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ null,
+ "pending"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL that points to the check suite API resource.",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "status",
+ "conclusion",
+ "url",
+ "before",
+ "after",
+ "pull_requests",
+ "app",
+ "created_at",
+ "updated_at",
+ "latest_check_runs_count",
+ "check_runs_url",
+ "head_commit"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "check_suite",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-suite-requested": {
+ "title": "check_suite requested event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "requested"
+ ]
+ },
+ "check_suite": {
+ "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).",
+ "type": "object",
+ "properties": {
+ "after": {
+ "type": "string",
+ "nullable": true
+ },
+ "app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "pull_request_review_thread",
+ "workflow_job",
+ "merge_queue_entry",
+ "security_and_analysis",
+ "secret_scanning_alert_location",
+ "projects_v2_item",
+ "merge_group",
+ "repository_import"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "before": {
+ "type": "string",
+ "nullable": true
+ },
+ "check_runs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null,
+ "skipped"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "head_branch": {
+ "description": "The head branch name the changes are on.",
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that is being checked.",
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "latest_check_runs_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_requests": {
+ "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "rerequestable": {
+ "type": "boolean"
+ },
+ "runs_rerequestable": {
+ "type": "boolean"
+ },
+ "status": {
+ "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ null
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL that points to the check suite API resource.",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "status",
+ "conclusion",
+ "url",
+ "before",
+ "after",
+ "pull_requests",
+ "app",
+ "created_at",
+ "updated_at",
+ "latest_check_runs_count",
+ "check_runs_url",
+ "head_commit"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "check_suite",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-check-suite-rerequested": {
+ "title": "check_suite rerequested event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "rerequested"
+ ]
+ },
+ "check_suite": {
+ "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).",
+ "type": "object",
+ "properties": {
+ "after": {
+ "type": "string",
+ "nullable": true
+ },
+ "app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "pull_request_review_thread",
+ "merge_queue_entry",
+ "workflow_job"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "before": {
+ "type": "string",
+ "nullable": true
+ },
+ "check_runs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "head_branch": {
+ "description": "The head branch name the changes are on.",
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_sha": {
+ "description": "The SHA of the head commit that is being checked.",
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "latest_check_runs_count": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_requests": {
+ "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "rerequestable": {
+ "type": "boolean"
+ },
+ "runs_rerequestable": {
+ "type": "boolean"
+ },
+ "status": {
+ "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ null
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL that points to the check suite API resource.",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "status",
+ "conclusion",
+ "url",
+ "before",
+ "after",
+ "pull_requests",
+ "app",
+ "created_at",
+ "updated_at",
+ "latest_check_runs_count",
+ "check_runs_url",
+ "head_commit"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "check_suite",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-appeared-in-branch": {
+ "title": "code_scanning_alert appeared_in_branch event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "appeared_in_branch"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "dismissed_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "false positive",
+ "won't fix",
+ "used in tests",
+ null
+ ]
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-closed-by-user": {
+ "title": "code_scanning_alert closed_by_user event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed_by_user"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "false positive",
+ "won't fix",
+ "used in tests",
+ null
+ ]
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "full_description": {
+ "type": "string"
+ },
+ "help": {
+ "type": "string",
+ "nullable": true
+ },
+ "help_uri": {
+ "description": "A link to the documentation for the rule used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ },
+ "tags": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "dismissed",
+ "fixed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-created": {
+ "title": "code_scanning_alert created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "dismissed_by": {
+ "nullable": true
+ },
+ "dismissed_comment": {
+ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
+ "nullable": true
+ },
+ "fixed_at": {
+ "nullable": true
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "instances_url": {
+ "type": "string"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "full_description": {
+ "type": "string"
+ },
+ "help": {
+ "type": "string",
+ "nullable": true
+ },
+ "help_uri": {
+ "description": "A link to the documentation for the rule used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ },
+ "tags": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "guid": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-fixed": {
+ "title": "code_scanning_alert fixed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "fixed"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "dismissed_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "false positive",
+ "won't fix",
+ "used in tests",
+ null
+ ]
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "instances_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "full_description": {
+ "type": "string"
+ },
+ "help": {
+ "type": "string",
+ "nullable": true
+ },
+ "help_uri": {
+ "description": "A link to the documentation for the rule used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ },
+ "tags": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "fixed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-reopened": {
+ "title": "code_scanning_alert reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "type": "string",
+ "nullable": true
+ },
+ "dismissed_by": {
+ "type": "object",
+ "nullable": true
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "full_description": {
+ "type": "string"
+ },
+ "help": {
+ "type": "string",
+ "nullable": true
+ },
+ "help_uri": {
+ "description": "A link to the documentation for the rule used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ },
+ "tags": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string",
+ "nullable": true
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string",
+ "nullable": true
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-code-scanning-alert-reopened-by-user": {
+ "title": "code_scanning_alert reopened_by_user event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened_by_user"
+ ]
+ },
+ "alert": {
+ "description": "The code scanning alert involved in the event.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`",
+ "type": "string",
+ "format": "date-time"
+ },
+ "dismissed_at": {
+ "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "nullable": true
+ },
+ "dismissed_by": {
+ "nullable": true
+ },
+ "dismissed_reason": {
+ "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
+ "nullable": true
+ },
+ "html_url": {
+ "description": "The GitHub URL of the alert resource.",
+ "type": "string",
+ "format": "uri"
+ },
+ "most_recent_instance": {
+ "title": "Alert Instance",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "analysis_key": {
+ "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
+ "type": "string"
+ },
+ "category": {
+ "description": "Identifies the configuration under which the analysis was executed.",
+ "type": "string"
+ },
+ "classifications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commit_sha": {
+ "type": "string"
+ },
+ "environment": {
+ "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.",
+ "type": "string"
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "end_column": {
+ "type": "integer"
+ },
+ "end_line": {
+ "type": "integer"
+ },
+ "path": {
+ "type": "string"
+ },
+ "start_column": {
+ "type": "integer"
+ },
+ "start_line": {
+ "type": "integer"
+ }
+ }
+ },
+ "message": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ }
+ }
+ },
+ "ref": {
+ "description": "The full Git reference, formatted as `refs/heads/`.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "analysis_key",
+ "environment",
+ "state"
+ ]
+ },
+ "number": {
+ "description": "The code scanning alert number.",
+ "type": "integer"
+ },
+ "rule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A short description of the rule used to detect the alert.",
+ "type": "string"
+ },
+ "id": {
+ "description": "A unique identifier for the rule used to detect the alert.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity of the alert.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "none",
+ "note",
+ "warning",
+ "error",
+ null
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "severity",
+ "description"
+ ]
+ },
+ "state": {
+ "description": "State of a code scanning alert.",
+ "type": "string",
+ "enum": [
+ "open",
+ "fixed"
+ ]
+ },
+ "tool": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the tool used to generate the code scanning analysis alert.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the tool used to detect the alert.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "url",
+ "html_url",
+ "state",
+ "dismissed_by",
+ "dismissed_at",
+ "dismissed_reason",
+ "rule",
+ "tool"
+ ]
+ },
+ "commit_oid": {
+ "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "ref",
+ "commit_oid",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-commit-comment-created": {
+ "title": "commit_comment created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action performed. Can be `created`.",
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "comment": {
+ "description": "The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource.",
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the commit comment.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the commit comment.",
+ "type": "string"
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string",
+ "nullable": true
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "body"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "comment",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-create": {
+ "title": "create event",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The repository's current description.",
+ "type": "string",
+ "nullable": true
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "master_branch": {
+ "description": "The name of the repository's default branch (usually `main`).",
+ "type": "string"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pusher_type": {
+ "description": "The pusher type for the event. Can be either `user` or a deploy key.",
+ "type": "string"
+ },
+ "ref": {
+ "description": "The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource.",
+ "type": "string"
+ },
+ "ref_type": {
+ "description": "The type of Git ref object created in the repository.",
+ "type": "string",
+ "enum": [
+ "tag",
+ "branch"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "ref",
+ "ref_type",
+ "master_branch",
+ "description",
+ "pusher_type",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-custom-property-created": {
+ "title": "custom property created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "definition": {
+ "$ref": "#/components/schemas/org-custom-property"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "definition",
+ "organization"
+ ]
+ },
+ "webhook-custom-property-deleted": {
+ "title": "custom property deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "definition": {
+ "type": "object",
+ "properties": {
+ "property_name": {
+ "type": "string",
+ "description": "The name of the property that was deleted."
+ }
+ },
+ "required": [
+ "property_name"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "definition",
+ "organization"
+ ]
+ },
+ "webhook-custom-property-updated": {
+ "title": "custom property updated event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "updated"
+ ]
+ },
+ "definition": {
+ "$ref": "#/components/schemas/org-custom-property"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "definition",
+ "organization"
+ ]
+ },
+ "webhook-custom-property-values-updated": {
+ "title": "Custom property values updated event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "updated"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "new_property_values": {
+ "type": "array",
+ "description": "The new custom property values for the repository.",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ }
+ },
+ "old_property_values": {
+ "type": "array",
+ "description": "The old custom property values for the repository.",
+ "items": {
+ "$ref": "#/components/schemas/custom-property-value"
+ }
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "organization",
+ "new_property_values",
+ "old_property_values"
+ ]
+ },
+ "webhook-delete": {
+ "title": "delete event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pusher_type": {
+ "description": "The pusher type for the event. Can be either `user` or a deploy key.",
+ "type": "string"
+ },
+ "ref": {
+ "description": "The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource.",
+ "type": "string"
+ },
+ "ref_type": {
+ "description": "The type of Git ref object deleted in the repository.",
+ "type": "string",
+ "enum": [
+ "tag",
+ "branch"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "ref",
+ "ref_type",
+ "pusher_type",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-auto-dismissed": {
+ "title": "Dependabot alert auto-dismissed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "auto_dismissed"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-auto-reopened": {
+ "title": "Dependabot alert auto-reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "auto_reopened"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-created": {
+ "title": "Dependabot alert created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-dismissed": {
+ "title": "Dependabot alert dismissed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "dismissed"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-fixed": {
+ "title": "Dependabot alert fixed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "fixed"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-reintroduced": {
+ "title": "Dependabot alert reintroduced event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reintroduced"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-dependabot-alert-reopened": {
+ "title": "Dependabot alert reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/dependabot-alert"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-deploy-key-created": {
+ "title": "deploy_key created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "key": {
+ "description": "The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.",
+ "type": "object",
+ "properties": {
+ "added_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "key": {
+ "type": "string"
+ },
+ "last_used": {
+ "type": "string",
+ "nullable": true
+ },
+ "read_only": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "key",
+ "url",
+ "title",
+ "verified",
+ "created_at",
+ "read_only"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "key",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-deploy-key-deleted": {
+ "title": "deploy_key deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "key": {
+ "description": "The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.",
+ "type": "object",
+ "properties": {
+ "added_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "key": {
+ "type": "string"
+ },
+ "last_used": {
+ "type": "string",
+ "nullable": true
+ },
+ "read_only": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "key",
+ "url",
+ "title",
+ "verified",
+ "created_at",
+ "read_only"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "key",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-deployment-created": {
+ "title": "deployment created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "deployment": {
+ "title": "Deployment",
+ "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "environment": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "original_environment": {
+ "type": "string"
+ },
+ "payload": {
+ "oneOf": [
+ {
+ "type": "object"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "workflow_job",
+ "pull_request_review_thread",
+ "merge_queue_entry",
+ "secret_scanning_alert_location",
+ "merge_group"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "production_environment": {
+ "type": "boolean"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "task": {
+ "type": "string"
+ },
+ "transient_environment": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "payload",
+ "original_environment",
+ "environment",
+ "description",
+ "creator",
+ "created_at",
+ "updated_at",
+ "statuses_url",
+ "repository_url"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "badge_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "badge_url",
+ "created_at",
+ "html_url",
+ "id",
+ "name",
+ "node_id",
+ "path",
+ "state",
+ "updated_at",
+ "url"
+ ]
+ },
+ "workflow_run": {
+ "title": "Deployment Workflow Run",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "display_title": {
+ "type": "string"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string"
+ },
+ "head_commit": {
+ "nullable": true
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "waiting",
+ "pending"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "run_number",
+ "event",
+ "status",
+ "conclusion",
+ "workflow_id",
+ "check_suite_id",
+ "check_suite_node_id",
+ "url",
+ "html_url",
+ "path",
+ "pull_requests",
+ "created_at",
+ "updated_at",
+ "actor",
+ "run_attempt",
+ "run_started_at",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "deployment",
+ "workflow",
+ "workflow_run",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-deployment-protection-rule-requested": {
+ "title": "deployment protection rule requested event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "requested"
+ ]
+ },
+ "environment": {
+ "description": "The name of the environment that has the deployment protection rule.",
+ "type": "string"
+ },
+ "event": {
+ "description": "The event that triggered the deployment protection rule.",
+ "type": "string"
+ },
+ "deployment_callback_url": {
+ "description": "The URL to review the deployment protection rule.",
+ "type": "string",
+ "format": "uri"
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment"
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pull-request"
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ }
+ },
+ "webhook-deployment-review-approved": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "approved"
+ ]
+ },
+ "approver": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "comment": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "reviewers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reviewer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "User"
+ ]
+ }
+ }
+ }
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "since": {
+ "type": "string"
+ },
+ "workflow_job_run": {
+ "type": "object",
+ "properties": {
+ "conclusion": {
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "nullable": true
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "status",
+ "conclusion",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "environment"
+ ]
+ },
+ "workflow_job_runs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "conclusion": {
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "workflow_run": {
+ "title": "Deployment Workflow Run",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "display_title": {
+ "type": "string"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string"
+ },
+ "head_commit": {
+ "type": "object",
+ "nullable": true
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "waiting",
+ "pending"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "run_number",
+ "event",
+ "status",
+ "conclusion",
+ "workflow_id",
+ "check_suite_id",
+ "check_suite_node_id",
+ "url",
+ "html_url",
+ "path",
+ "pull_requests",
+ "created_at",
+ "updated_at",
+ "actor",
+ "triggering_actor",
+ "run_attempt",
+ "run_started_at",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "workflow_run",
+ "since",
+ "repository",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-deployment-review-rejected": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "rejected"
+ ]
+ },
+ "approver": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "comment": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "reviewers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reviewer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "User"
+ ]
+ }
+ }
+ }
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "since": {
+ "type": "string"
+ },
+ "workflow_job_run": {
+ "type": "object",
+ "properties": {
+ "conclusion": {
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "nullable": true
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "status",
+ "conclusion",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "environment"
+ ]
+ },
+ "workflow_job_runs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "conclusion": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "workflow_run": {
+ "title": "Deployment Workflow Run",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string"
+ },
+ "head_commit": {
+ "type": "object",
+ "nullable": true
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "waiting"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ },
+ "display_title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "run_number",
+ "event",
+ "status",
+ "conclusion",
+ "workflow_id",
+ "check_suite_id",
+ "check_suite_node_id",
+ "url",
+ "html_url",
+ "path",
+ "pull_requests",
+ "created_at",
+ "updated_at",
+ "actor",
+ "triggering_actor",
+ "run_attempt",
+ "run_started_at",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "workflow_run",
+ "since",
+ "repository",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-deployment-review-requested": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "requested"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requestor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "reviewers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reviewer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "User",
+ "Team"
+ ]
+ }
+ }
+ }
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "since": {
+ "type": "string"
+ },
+ "workflow_job_run": {
+ "type": "object",
+ "properties": {
+ "conclusion": {
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "status",
+ "conclusion",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "environment"
+ ]
+ },
+ "workflow_run": {
+ "title": "Deployment Workflow Run",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string"
+ },
+ "head_commit": {
+ "type": "object",
+ "nullable": true
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "waiting",
+ "pending"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ },
+ "display_title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "run_number",
+ "event",
+ "status",
+ "conclusion",
+ "workflow_id",
+ "check_suite_id",
+ "check_suite_node_id",
+ "url",
+ "html_url",
+ "path",
+ "pull_requests",
+ "created_at",
+ "updated_at",
+ "actor",
+ "triggering_actor",
+ "run_attempt",
+ "run_started_at",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "workflow_run",
+ "since",
+ "workflow_job_run",
+ "environment",
+ "reviewers",
+ "requestor",
+ "repository",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-deployment-status-created": {
+ "title": "deployment_status created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "check_run": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "conclusion": {
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ "skipped",
+ null
+ ]
+ },
+ "details_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "external_id": {
+ "type": "string"
+ },
+ "head_sha": {
+ "description": "The SHA of the commit that is being checked.",
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The id of the check.",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the check run.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "waiting",
+ "pending"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_sha",
+ "external_id",
+ "url",
+ "html_url",
+ "details_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at"
+ ]
+ },
+ "deployment": {
+ "title": "Deployment",
+ "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "environment": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "original_environment": {
+ "type": "string"
+ },
+ "payload": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "merge_queue_entry",
+ "workflow_job",
+ "pull_request_review_thread",
+ "secret_scanning_alert_location",
+ "merge_group"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "production_environment": {
+ "type": "boolean"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "task": {
+ "type": "string"
+ },
+ "transient_environment": {
+ "type": "boolean"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "payload",
+ "original_environment",
+ "environment",
+ "description",
+ "creator",
+ "created_at",
+ "updated_at",
+ "statuses_url",
+ "repository_url"
+ ]
+ },
+ "deployment_status": {
+ "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "deployment_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "description": "The optional human-readable description added to the status.",
+ "type": "string"
+ },
+ "environment": {
+ "type": "string"
+ },
+ "environment_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "log_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "pull_request_review_thread",
+ "merge_queue_entry",
+ "workflow_job",
+ "merge_group",
+ "secret_scanning_alert_location"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.",
+ "type": "string"
+ },
+ "target_url": {
+ "description": "The optional link added to the status.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "state",
+ "creator",
+ "description",
+ "environment",
+ "target_url",
+ "created_at",
+ "updated_at",
+ "deployment_url",
+ "repository_url"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "badge_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "badge_url",
+ "created_at",
+ "html_url",
+ "id",
+ "name",
+ "node_id",
+ "path",
+ "state",
+ "updated_at",
+ "url"
+ ]
+ },
+ "workflow_run": {
+ "title": "Deployment Workflow Run",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null,
+ "startup_failure"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "display_title": {
+ "type": "string"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string"
+ },
+ "head_commit": {
+ "nullable": true
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "title": "Check Run Pull Request",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "integer"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "waiting",
+ "pending"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "node_id",
+ "head_branch",
+ "head_sha",
+ "run_number",
+ "event",
+ "status",
+ "conclusion",
+ "workflow_id",
+ "check_suite_id",
+ "check_suite_node_id",
+ "url",
+ "html_url",
+ "path",
+ "pull_requests",
+ "created_at",
+ "updated_at",
+ "actor",
+ "triggering_actor",
+ "run_attempt",
+ "run_started_at",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "deployment_status",
+ "deployment",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-answered": {
+ "title": "discussion answered event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "answered"
+ ]
+ },
+ "answer": {
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "child_comment_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "discussion_id": {
+ "type": "integer"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent_id": {
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "parent_id",
+ "child_comment_count",
+ "repository_url",
+ "discussion_id",
+ "author_association",
+ "user",
+ "created_at",
+ "updated_at",
+ "body"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "answer",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-category-changed": {
+ "title": "discussion category changed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "category_changed"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string"
+ },
+ "emoji": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_answerable": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "emoji",
+ "name",
+ "description",
+ "created_at",
+ "updated_at",
+ "slug",
+ "is_answerable"
+ ]
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "category"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-closed": {
+ "title": "discussion closed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-comment-created": {
+ "title": "discussion_comment created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "comment": {
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "child_comment_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "discussion_id": {
+ "type": "integer"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "parent_id",
+ "child_comment_count",
+ "repository_url",
+ "discussion_id",
+ "author_association",
+ "user",
+ "created_at",
+ "updated_at",
+ "body",
+ "reactions"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "comment",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-comment-deleted": {
+ "title": "discussion_comment deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "comment": {
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "child_comment_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "discussion_id": {
+ "type": "integer"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "parent_id",
+ "child_comment_count",
+ "repository_url",
+ "discussion_id",
+ "author_association",
+ "user",
+ "created_at",
+ "updated_at",
+ "body",
+ "reactions"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "comment",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-comment-edited": {
+ "title": "discussion_comment edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "comment": {
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "child_comment_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "discussion_id": {
+ "type": "integer"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "parent_id",
+ "child_comment_count",
+ "repository_url",
+ "discussion_id",
+ "author_association",
+ "user",
+ "created_at",
+ "updated_at",
+ "body",
+ "reactions"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "comment",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-created": {
+ "title": "discussion created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "discussion": {
+ "allOf": [
+ {
+ "title": "Discussion",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "answer_chosen_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "answer_chosen_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "answer_html_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "category": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string"
+ },
+ "emoji": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_answerable": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "repository_id",
+ "emoji",
+ "name",
+ "description",
+ "created_at",
+ "updated_at",
+ "slug",
+ "is_answerable"
+ ]
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "locked",
+ "converting",
+ "transferring"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "repository_url",
+ "category",
+ "answer_html_url",
+ "answer_chosen_at",
+ "answer_chosen_by",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "state",
+ "locked",
+ "comments",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "active_lock_reason",
+ "body"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "nullable": true
+ },
+ "answer_chosen_at": {
+ "nullable": true
+ },
+ "answer_chosen_by": {
+ "nullable": true
+ },
+ "answer_html_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "category": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "emoji": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_answerable": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "repository_id": {
+ "type": "integer"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ }
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "locked": {
+ "type": "boolean",
+ "enum": [
+ false
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "converting",
+ "transferring"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "state",
+ "locked",
+ "answer_html_url",
+ "answer_chosen_at",
+ "answer_chosen_by"
+ ]
+ }
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-deleted": {
+ "title": "discussion deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-edited": {
+ "title": "discussion edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "title": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-labeled": {
+ "title": "discussion labeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "labeled"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "label",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-locked": {
+ "title": "discussion locked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "locked"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-pinned": {
+ "title": "discussion pinned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pinned"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-reopened": {
+ "title": "discussion reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-transferred": {
+ "title": "discussion transferred event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "transferred"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "new_discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "new_repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ }
+ },
+ "required": [
+ "new_discussion",
+ "new_repository"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-unanswered": {
+ "title": "discussion unanswered event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unanswered"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "old_answer": {
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "child_comment_count": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "discussion_id": {
+ "type": "integer"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent_id": {
+ "nullable": true
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "parent_id",
+ "child_comment_count",
+ "repository_url",
+ "discussion_id",
+ "author_association",
+ "user",
+ "created_at",
+ "updated_at",
+ "body"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "old_answer",
+ "repository"
+ ]
+ },
+ "webhook-discussion-unlabeled": {
+ "title": "discussion unlabeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlabeled"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "label",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-unlocked": {
+ "title": "discussion unlocked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlocked"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-discussion-unpinned": {
+ "title": "discussion unpinned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unpinned"
+ ]
+ },
+ "discussion": {
+ "$ref": "#/components/schemas/discussion"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "discussion",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-fork": {
+ "title": "fork event",
+ "description": "A user forks a repository.",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "forkee": {
+ "description": "The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource.",
+ "allOf": [
+ {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean",
+ "enum": [
+ true
+ ]
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "language": {
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "license": {
+ "type": "object",
+ "nullable": true
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "nullable": true
+ }
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "visibility": {
+ "type": "string"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ }
+ }
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "forkee",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-github-app-authorization-revoked": {
+ "title": "github_app_authorization revoked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "revoked"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "sender"
+ ]
+ },
+ "webhook-gollum": {
+ "title": "gollum event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pages": {
+ "description": "The pages that were updated.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action that was performed on the page. Can be `created` or `edited`.",
+ "type": "string",
+ "enum": [
+ "created",
+ "edited"
+ ]
+ },
+ "html_url": {
+ "description": "Points to the HTML wiki page.",
+ "type": "string",
+ "format": "uri"
+ },
+ "page_name": {
+ "description": "The name of the page.",
+ "type": "string"
+ },
+ "sha": {
+ "description": "The latest commit SHA of the page.",
+ "type": "string"
+ },
+ "summary": {
+ "type": "string",
+ "nullable": true
+ },
+ "title": {
+ "description": "The current page title.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "page_name",
+ "title",
+ "summary",
+ "action",
+ "sha",
+ "html_url"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "pages",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-installation-created": {
+ "title": "installation created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories": {
+ "description": "An array of repository objects that the installation can access.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requester": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "sender"
+ ]
+ },
+ "webhook-installation-deleted": {
+ "title": "installation deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories": {
+ "description": "An array of repository objects that the installation can access.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requester": {
+ "nullable": true
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "sender"
+ ]
+ },
+ "webhook-installation-new-permissions-accepted": {
+ "title": "installation new_permissions_accepted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "new_permissions_accepted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories": {
+ "description": "An array of repository objects that the installation can access.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requester": {
+ "nullable": true
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "sender"
+ ]
+ },
+ "webhook-installation-repositories-added": {
+ "title": "installation_repositories added event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "added"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories_added": {
+ "description": "An array of repository objects, which were added to the installation.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repositories_removed": {
+ "description": "An array of repository objects, which were removed from the installation.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_selection": {
+ "description": "Describe whether all repositories have been selected or there's a selection involved",
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ },
+ "requester": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "repository_selection",
+ "repositories_added",
+ "repositories_removed",
+ "requester",
+ "sender"
+ ]
+ },
+ "webhook-installation-repositories-removed": {
+ "title": "installation_repositories removed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories_added": {
+ "description": "An array of repository objects, which were added to the installation.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repositories_removed": {
+ "description": "An array of repository objects, which were removed from the installation.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_selection": {
+ "description": "Describe whether all repositories have been selected or there's a selection involved",
+ "type": "string",
+ "enum": [
+ "all",
+ "selected"
+ ]
+ },
+ "requester": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "repository_selection",
+ "repositories_added",
+ "repositories_removed",
+ "requester",
+ "sender"
+ ]
+ },
+ "webhook-installation-suspend": {
+ "title": "installation suspend event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "suspend"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories": {
+ "description": "An array of repository objects that the installation can access.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requester": {
+ "nullable": true
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "sender"
+ ]
+ },
+ "webhook-installation-target-renamed": {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "archived_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "has_organization_projects": {
+ "type": "boolean"
+ },
+ "has_repository_projects": {
+ "type": "boolean"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "is_verified": {
+ "type": "boolean"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "login": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "public_members_url": {
+ "type": "string"
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "website_url": {
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "avatar_url",
+ "html_url"
+ ]
+ },
+ "action": {
+ "type": "string",
+ "enum": [
+ "renamed"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "slug": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "target_type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "target_type",
+ "account",
+ "changes",
+ "installation"
+ ]
+ },
+ "webhook-installation-unsuspend": {
+ "title": "installation unsuspend event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unsuspend"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repositories": {
+ "description": "An array of repository objects that the installation can access.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "full_name": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private"
+ ]
+ }
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requester": {
+ "nullable": true
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "installation",
+ "sender"
+ ]
+ },
+ "webhook-issue-comment-created": {
+ "title": "issue_comment created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "comment": {
+ "title": "issue comment",
+ "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.",
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue comment",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the issue comment",
+ "type": "integer",
+ "format": "int64"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "issue_url",
+ "id",
+ "node_id",
+ "user",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "performed_via_github_app",
+ "body",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.",
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "labels",
+ "state",
+ "locked",
+ "assignee"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "comment",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issue-comment-deleted": {
+ "title": "issue_comment deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "comment": {
+ "title": "issue comment",
+ "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.",
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue comment",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the issue comment",
+ "type": "integer",
+ "format": "int64"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "issue_url",
+ "id",
+ "node_id",
+ "user",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "performed_via_github_app",
+ "body",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.",
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "labels",
+ "state",
+ "locked",
+ "assignee"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "comment",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issue-comment-edited": {
+ "title": "issue_comment edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the comment.",
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "comment": {
+ "title": "issue comment",
+ "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.",
+ "type": "object",
+ "properties": {
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue comment",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the issue comment",
+ "type": "integer",
+ "format": "int64"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "performed_via_github_app": {
+ "$ref": "#/components/schemas/nullable-integration"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "issue_url",
+ "id",
+ "node_id",
+ "user",
+ "created_at",
+ "updated_at",
+ "author_association",
+ "performed_via_github_app",
+ "body",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.",
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "labels",
+ "state",
+ "locked",
+ "assignee"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "issue",
+ "comment",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-assigned": {
+ "title": "issues assigned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action that was performed.",
+ "type": "string",
+ "enum": [
+ "assigned"
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-closed": {
+ "title": "issues closed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action that was performed.",
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "security_and_analysis",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "closed",
+ "open"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "state",
+ "closed_at"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-deleted": {
+ "title": "issues deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-demilestoned": {
+ "title": "issues demilestoned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "demilestoned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "milestone"
+ ]
+ }
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-edited": {
+ "title": "issues edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the issue.",
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "title": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the title.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "security_and_analysis",
+ "pull_request_review_thread",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-labeled": {
+ "title": "issues labeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "labeled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "pull_request_review_thread",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-locked": {
+ "title": "issues locked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "locked"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "security_and_analysis"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean",
+ "enum": [
+ true
+ ]
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "locked",
+ "active_lock_reason"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-milestoned": {
+ "title": "issues milestoned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "milestoned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "milestone"
+ ]
+ }
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-opened": {
+ "title": "issues opened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "opened"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "old_issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "old_repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_discussions": {
+ "description": "Whether the repository has discussions enabled.",
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require commit signoff.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ }
+ },
+ "required": [
+ "old_issue",
+ "old_repository"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "security_and_analysis",
+ "pull_request_review_thread",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-pinned": {
+ "title": "issues pinned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pinned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-reopened": {
+ "title": "issues reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "pull_request_review_thread",
+ "reminder"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "type": "object",
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "state"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-transferred": {
+ "title": "issues transferred event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "transferred"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "new_issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "new_repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ }
+ },
+ "required": [
+ "new_issue",
+ "new_repository"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-unassigned": {
+ "title": "issues unassigned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action that was performed.",
+ "type": "string",
+ "enum": [
+ "unassigned"
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-unlabeled": {
+ "title": "issues unlabeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlabeled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run",
+ "reminder",
+ "pull_request_review_thread"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-unlocked": {
+ "title": "issues unlocked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlocked"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "allOf": [
+ {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "nullable": true
+ },
+ "assignee": {
+ "type": "object",
+ "nullable": true
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "locked": {
+ "type": "boolean",
+ "enum": [
+ false
+ ]
+ },
+ "milestone": {
+ "type": "object",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "nullable": true
+ },
+ "reactions": {
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "repository_url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "locked",
+ "active_lock_reason"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-issues-unpinned": {
+ "title": "issues unpinned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unpinned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "issue": {
+ "title": "Issue",
+ "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.",
+ "type": "object",
+ "properties": {
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "Contents of the issue",
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "performed_via_github_app": {
+ "title": "App",
+ "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events": {
+ "description": "The list of events for the GitHub app",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "content_reference",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_review",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "milestone",
+ "organization",
+ "org_block",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_dispatch",
+ "secret_scanning_alert",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_dispatch",
+ "workflow_run"
+ ]
+ }
+ },
+ "external_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the GitHub app",
+ "type": "integer",
+ "nullable": true
+ },
+ "name": {
+ "description": "The name of the GitHub app",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "description": "The set of permissions for the GitHub app",
+ "type": "object",
+ "properties": {
+ "actions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "checks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "content_references": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "contents": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "deployments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "emails": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "environments": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "issues": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "keys": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "members": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "metadata": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_administration": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_plan": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_self_hosted_runners": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "organization_user_blocking": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "packages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pages": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "pull_requests": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_hooks": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "repository_projects": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secret_scanning_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "secrets": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_events": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "security_scanning_alert": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "single_file": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "team_discussions": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "vulnerability_alerts": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ },
+ "workflows": {
+ "type": "string",
+ "enum": [
+ "read",
+ "write"
+ ]
+ }
+ }
+ },
+ "slug": {
+ "description": "The slug name of the GitHub app",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "owner",
+ "name",
+ "description",
+ "external_url",
+ "html_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the issue; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "state_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "Title of the issue",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the issue",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "repository_url",
+ "labels_url",
+ "comments_url",
+ "events_url",
+ "html_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "user",
+ "assignees",
+ "milestone",
+ "comments",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "author_association",
+ "active_lock_reason",
+ "body",
+ "reactions"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "issue",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-label-created": {
+ "title": "label created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "label",
+ "repository"
+ ]
+ },
+ "webhook-label-deleted": {
+ "title": "label deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "label",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-label-edited": {
+ "title": "label edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the label if the action was `edited`.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the color if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the description if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the name if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "label",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-marketplace-purchase-cancelled": {
+ "title": "marketplace_purchase cancelled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "cancelled"
+ ]
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "marketplace_purchase": {
+ "allOf": [
+ {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ }
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "next_billing_date"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "previous_marketplace_purchase": {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "effective_date",
+ "sender",
+ "marketplace_purchase"
+ ]
+ },
+ "webhook-marketplace-purchase-changed": {
+ "title": "marketplace_purchase changed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "changed"
+ ]
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "marketplace_purchase": {
+ "allOf": [
+ {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ }
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "next_billing_date"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "previous_marketplace_purchase": {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "effective_date",
+ "sender",
+ "marketplace_purchase"
+ ]
+ },
+ "webhook-marketplace-purchase-pending-change": {
+ "title": "marketplace_purchase pending_change event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pending_change"
+ ]
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "marketplace_purchase": {
+ "allOf": [
+ {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ }
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "next_billing_date"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "previous_marketplace_purchase": {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "effective_date",
+ "sender",
+ "marketplace_purchase"
+ ]
+ },
+ "webhook-marketplace-purchase-pending-change-cancelled": {
+ "title": "marketplace_purchase pending_change_cancelled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pending_change_cancelled"
+ ]
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "marketplace_purchase": {
+ "allOf": [
+ {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "next_billing_date": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "next_billing_date"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "previous_marketplace_purchase": {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "effective_date",
+ "sender",
+ "marketplace_purchase"
+ ]
+ },
+ "webhook-marketplace-purchase-purchased": {
+ "title": "marketplace_purchase purchased event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "purchased"
+ ]
+ },
+ "effective_date": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "marketplace_purchase": {
+ "allOf": [
+ {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "type": "string",
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ }
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "next_billing_date"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "previous_marketplace_purchase": {
+ "title": "Marketplace Purchase",
+ "type": "object",
+ "properties": {
+ "account": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organization_billing_email": {
+ "type": "string",
+ "nullable": true
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "node_id",
+ "login",
+ "organization_billing_email"
+ ]
+ },
+ "billing_cycle": {
+ "type": "string"
+ },
+ "free_trial_ends_on": {
+ "nullable": true
+ },
+ "next_billing_date": {
+ "type": "string",
+ "nullable": true
+ },
+ "on_free_trial": {
+ "type": "boolean"
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "bullets": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "has_free_trial": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "price_model": {
+ "type": "string",
+ "enum": [
+ "FREE",
+ "FLAT_RATE",
+ "PER_UNIT"
+ ]
+ },
+ "unit_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "yearly_price_in_cents": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "monthly_price_in_cents",
+ "yearly_price_in_cents",
+ "price_model",
+ "has_free_trial",
+ "unit_name",
+ "bullets"
+ ]
+ },
+ "unit_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "account",
+ "billing_cycle",
+ "unit_count",
+ "on_free_trial",
+ "free_trial_ends_on",
+ "plan"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "effective_date",
+ "sender",
+ "marketplace_purchase"
+ ]
+ },
+ "webhook-member-added": {
+ "title": "member added event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "added"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "object",
+ "properties": {
+ "to": {
+ "type": "string",
+ "enum": [
+ "write",
+ "admin",
+ "read"
+ ]
+ }
+ },
+ "required": [
+ "to"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "member": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "member",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-member-edited": {
+ "title": "member edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the collaborator permissions",
+ "type": "object",
+ "properties": {
+ "old_permission": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous permissions of the collaborator if the action was edited.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "permission": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "member": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "member",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-member-removed": {
+ "title": "member removed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "member": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "member",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-membership-added": {
+ "title": "membership added event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "added"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "member": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "scope": {
+ "description": "The scope of the membership. Currently, can only be `team`.",
+ "type": "string",
+ "enum": [
+ "team"
+ ]
+ },
+ "sender": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "scope",
+ "member",
+ "sender",
+ "team",
+ "organization"
+ ]
+ },
+ "webhook-membership-removed": {
+ "title": "membership removed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "member": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "scope": {
+ "description": "The scope of the membership. Currently, can only be `team`.",
+ "type": "string",
+ "enum": [
+ "team",
+ "organization"
+ ]
+ },
+ "sender": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "scope",
+ "member",
+ "sender",
+ "team",
+ "organization"
+ ]
+ },
+ "webhook-merge-group-checks-requested": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "checks_requested"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "merge_group": {
+ "$ref": "#/components/schemas/merge-group"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "merge_group"
+ ]
+ },
+ "webhook-merge-group-destroyed": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "destroyed"
+ ]
+ },
+ "reason": {
+ "type": "string",
+ "description": "Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).",
+ "enum": [
+ "merged",
+ "invalidated",
+ "dequeued"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "merge_group": {
+ "$ref": "#/components/schemas/merge-group"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "merge_group"
+ ]
+ },
+ "webhook-meta-deleted": {
+ "title": "meta deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "hook": {
+ "description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.",
+ "type": "object",
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "string",
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "content_type",
+ "insecure_ssl",
+ "url"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "*",
+ "branch_protection_rule",
+ "check_run",
+ "check_suite",
+ "code_scanning_alert",
+ "commit_comment",
+ "create",
+ "delete",
+ "deployment",
+ "deployment_status",
+ "deploy_key",
+ "discussion",
+ "discussion_comment",
+ "fork",
+ "gollum",
+ "issues",
+ "issue_comment",
+ "label",
+ "member",
+ "membership",
+ "meta",
+ "milestone",
+ "organization",
+ "org_block",
+ "package",
+ "page_build",
+ "project",
+ "project_card",
+ "project_column",
+ "public",
+ "pull_request",
+ "pull_request_review",
+ "pull_request_review_comment",
+ "pull_request_review_thread",
+ "push",
+ "registry_package",
+ "release",
+ "repository",
+ "repository_import",
+ "repository_vulnerability_alert",
+ "secret_scanning_alert",
+ "secret_scanning_alert_location",
+ "security_and_analysis",
+ "star",
+ "status",
+ "team",
+ "team_add",
+ "watch",
+ "workflow_job",
+ "workflow_run",
+ "repository_dispatch",
+ "projects_v2_item"
+ ],
+ "minItems": 1
+ }
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "name",
+ "active",
+ "events",
+ "config",
+ "updated_at",
+ "created_at"
+ ]
+ },
+ "hook_id": {
+ "description": "The id of the modified webhook.",
+ "type": "integer"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "hook_id",
+ "hook"
+ ]
+ },
+ "webhook-milestone-closed": {
+ "title": "milestone closed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-milestone-created": {
+ "title": "milestone created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-milestone-deleted": {
+ "title": "milestone deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-milestone-edited": {
+ "title": "milestone edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the milestone if the action was `edited`.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the description if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "due_on": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the due date if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "title": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the title if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-milestone-opened": {
+ "title": "milestone opened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "opened"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "milestone",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-org-block-blocked": {
+ "title": "org_block blocked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "blocked"
+ ]
+ },
+ "blocked_user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "blocked_user",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-org-block-unblocked": {
+ "title": "org_block unblocked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unblocked"
+ ]
+ },
+ "blocked_user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "blocked_user",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-organization-deleted": {
+ "title": "organization deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "membership": {
+ "title": "Membership",
+ "description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
+ "type": "object",
+ "properties": {
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "state",
+ "role",
+ "organization_url",
+ "user"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-organization-member-added": {
+ "title": "organization member_added event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "member_added"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "membership": {
+ "title": "Membership",
+ "description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
+ "type": "object",
+ "properties": {
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "state",
+ "role",
+ "organization_url",
+ "user"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "membership",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-organization-member-invited": {
+ "title": "organization member_invited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "member_invited"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "invitation": {
+ "description": "The invitation for the user or email if the action is `member_invited`.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "number"
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "inviter": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string"
+ },
+ "team_count": {
+ "type": "number"
+ },
+ "invitation_source": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "login",
+ "email",
+ "role",
+ "created_at",
+ "failed_at",
+ "failed_reason",
+ "inviter",
+ "team_count",
+ "invitation_teams_url"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "invitation",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-organization-member-removed": {
+ "title": "organization member_removed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "member_removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "membership": {
+ "title": "Membership",
+ "description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
+ "type": "object",
+ "properties": {
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "state",
+ "role",
+ "organization_url",
+ "user"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "membership",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-organization-renamed": {
+ "title": "organization renamed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "renamed"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "membership": {
+ "title": "Membership",
+ "description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
+ "type": "object",
+ "properties": {
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "state",
+ "role",
+ "organization_url",
+ "user"
+ ]
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-rubygems-metadata": {
+ "title": "Ruby Gems metadata",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "readme": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string"
+ },
+ "version_info": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "type": "string"
+ }
+ }
+ },
+ "platform": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "repo": {
+ "type": "string"
+ },
+ "dependencies": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "commit_oid": {
+ "type": "string"
+ }
+ }
+ },
+ "webhook-package-published": {
+ "title": "package published event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "published"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "package": {
+ "description": "Information about the package.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "ecosystem": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "namespace": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "package_type": {
+ "type": "string"
+ },
+ "package_version": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "container_metadata": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "labels": {
+ "type": "object",
+ "nullable": true
+ },
+ "manifest": {
+ "type": "object",
+ "nullable": true
+ },
+ "tag": {
+ "type": "object",
+ "properties": {
+ "digest": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "docker_metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "manifest": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "npm_metadata": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ },
+ "npm_user": {
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "nullable": true
+ },
+ "bugs": {
+ "type": "object",
+ "nullable": true
+ },
+ "dependencies": {
+ "type": "object"
+ },
+ "dev_dependencies": {
+ "type": "object"
+ },
+ "peer_dependencies": {
+ "type": "object"
+ },
+ "optional_dependencies": {
+ "type": "object"
+ },
+ "description": {
+ "type": "string"
+ },
+ "dist": {
+ "type": "object",
+ "nullable": true
+ },
+ "git_head": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string"
+ },
+ "license": {
+ "type": "string"
+ },
+ "main": {
+ "type": "string"
+ },
+ "repository": {
+ "type": "object",
+ "nullable": true
+ },
+ "scripts": {
+ "type": "object"
+ },
+ "id": {
+ "type": "string"
+ },
+ "node_version": {
+ "type": "string"
+ },
+ "npm_version": {
+ "type": "string"
+ },
+ "has_shrinkwrap": {
+ "type": "boolean"
+ },
+ "maintainers": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "contributors": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "engines": {
+ "type": "object"
+ },
+ "keywords": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "files": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "bin": {
+ "type": "object"
+ },
+ "man": {
+ "type": "object"
+ },
+ "directories": {
+ "type": "object",
+ "nullable": true
+ },
+ "os": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cpu": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "readme": {
+ "type": "string"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "release_id": {
+ "type": "integer"
+ },
+ "commit_oid": {
+ "type": "string"
+ },
+ "published_via_actions": {
+ "type": "boolean"
+ },
+ "deleted_by_id": {
+ "type": "integer"
+ }
+ }
+ },
+ "nuget_metadata": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "branch": {
+ "type": "string"
+ },
+ "commit": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "package_files": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "md5": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string",
+ "nullable": true
+ },
+ "sha256": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "download_url",
+ "id",
+ "name",
+ "sha256",
+ "sha1",
+ "md5",
+ "content_type",
+ "state",
+ "size",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "package_url": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "release": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at"
+ ]
+ },
+ "rubygems_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
+ }
+ },
+ "source_url": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "target_oid": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "version",
+ "summary",
+ "name",
+ "description",
+ "html_url",
+ "metadata",
+ "package_files",
+ "installation_command"
+ ]
+ },
+ "registry": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "about_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "vendor": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "about_url",
+ "name",
+ "type",
+ "url",
+ "vendor"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "namespace",
+ "description",
+ "ecosystem",
+ "package_type",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "owner",
+ "package_version",
+ "registry"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "package",
+ "sender"
+ ]
+ },
+ "webhook-package-updated": {
+ "title": "package updated event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "updated"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "package": {
+ "description": "Information about the package.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "ecosystem": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "namespace": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "package_type": {
+ "type": "string"
+ },
+ "package_version": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "docker_metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "manifest": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "package_files": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "md5": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string",
+ "nullable": true
+ },
+ "sha256": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "download_url",
+ "id",
+ "name",
+ "sha256",
+ "sha1",
+ "md5",
+ "content_type",
+ "state",
+ "size",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "package_url": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "release": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at"
+ ]
+ },
+ "rubygems_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
+ }
+ },
+ "source_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "target_oid": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "version",
+ "summary",
+ "name",
+ "description",
+ "body",
+ "body_html",
+ "html_url",
+ "target_commitish",
+ "target_oid",
+ "created_at",
+ "updated_at",
+ "metadata",
+ "package_files",
+ "author",
+ "installation_command"
+ ]
+ },
+ "registry": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "about_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "vendor": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "about_url",
+ "name",
+ "type",
+ "url",
+ "vendor"
+ ]
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "namespace",
+ "description",
+ "ecosystem",
+ "package_type",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "owner",
+ "package_version",
+ "registry"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "package",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-page-build": {
+ "title": "page_build event",
+ "type": "object",
+ "properties": {
+ "build": {
+ "description": "The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself.",
+ "type": "object",
+ "properties": {
+ "commit": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "duration": {
+ "type": "integer"
+ },
+ "error": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "message"
+ ]
+ },
+ "pusher": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "status": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "status",
+ "error",
+ "pusher",
+ "commit",
+ "duration",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "id",
+ "build",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-personal-access-token-request-approved": {
+ "title": "personal_access_token_request approved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "approved"
+ ]
+ },
+ "personal_access_token_request": {
+ "$ref": "#/components/schemas/personal-access-token-request"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ }
+ },
+ "required": [
+ "action",
+ "personal_access_token_request",
+ "organization",
+ "sender",
+ "installation"
+ ]
+ },
+ "webhook-personal-access-token-request-cancelled": {
+ "title": "personal_access_token_request cancelled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "cancelled"
+ ]
+ },
+ "personal_access_token_request": {
+ "$ref": "#/components/schemas/personal-access-token-request"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ }
+ },
+ "required": [
+ "action",
+ "personal_access_token_request",
+ "organization",
+ "sender",
+ "installation"
+ ]
+ },
+ "webhook-personal-access-token-request-created": {
+ "title": "personal_access_token_request created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "personal_access_token_request": {
+ "$ref": "#/components/schemas/personal-access-token-request"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ }
+ },
+ "required": [
+ "action",
+ "personal_access_token_request",
+ "organization",
+ "sender",
+ "installation"
+ ]
+ },
+ "webhook-personal-access-token-request-denied": {
+ "title": "personal_access_token_request denied event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "denied"
+ ]
+ },
+ "personal_access_token_request": {
+ "$ref": "#/components/schemas/personal-access-token-request"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ }
+ },
+ "required": [
+ "action",
+ "personal_access_token_request",
+ "organization",
+ "sender",
+ "installation"
+ ]
+ },
+ "webhook-ping": {
+ "type": "object",
+ "properties": {
+ "hook": {
+ "title": "Webhook",
+ "description": "The webhook that is being pinged",
+ "type": "object",
+ "properties": {
+ "active": {
+ "description": "Determines whether the hook is actually triggered for the events it subscribes to.",
+ "type": "boolean"
+ },
+ "app_id": {
+ "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.",
+ "type": "integer"
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "$ref": "#/components/schemas/webhook-config-content-type"
+ },
+ "insecure_ssl": {
+ "$ref": "#/components/schemas/webhook-config-insecure-ssl"
+ },
+ "secret": {
+ "$ref": "#/components/schemas/webhook-config-secret"
+ },
+ "url": {
+ "$ref": "#/components/schemas/webhook-config-url"
+ }
+ }
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deliveries_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "type": "integer"
+ },
+ "last_response": {
+ "$ref": "#/components/schemas/hook-response"
+ },
+ "name": {
+ "description": "The type of webhook. The only valid value is 'web'.",
+ "type": "string",
+ "enum": [
+ "web"
+ ]
+ },
+ "ping_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "test_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "hook_id": {
+ "description": "The ID of the webhook that triggered the ping.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "zen": {
+ "description": "Random string of GitHub zen.",
+ "type": "string"
+ }
+ }
+ },
+ "webhook-ping-form-encoded": {
+ "description": "The webhooks ping payload encoded with URL encoding.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-project-card-converted": {
+ "title": "project_card converted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "converted"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "note"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_card": {
+ "title": "Project Card",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer"
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "id": {
+ "description": "The project card's ID",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "column_url",
+ "column_id",
+ "id",
+ "node_id",
+ "note",
+ "archived",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "project_card",
+ "sender"
+ ]
+ },
+ "webhook-project-card-created": {
+ "title": "project_card created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_card": {
+ "title": "Project Card",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer"
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "id": {
+ "description": "The project card's ID",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "column_url",
+ "column_id",
+ "id",
+ "node_id",
+ "note",
+ "archived",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_card",
+ "sender"
+ ]
+ },
+ "webhook-project-card-deleted": {
+ "title": "project_card deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_card": {
+ "title": "Project Card",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "id": {
+ "description": "The project card's ID",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "column_url",
+ "column_id",
+ "id",
+ "node_id",
+ "note",
+ "archived",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_card",
+ "sender"
+ ]
+ },
+ "webhook-project-card-edited": {
+ "title": "project_card edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "note"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_card": {
+ "title": "Project Card",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer"
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "id": {
+ "description": "The project card's ID",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "column_url",
+ "column_id",
+ "id",
+ "node_id",
+ "note",
+ "archived",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "project_card",
+ "sender"
+ ]
+ },
+ "webhook-project-card-moved": {
+ "title": "project_card moved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "moved"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "column_id": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "column_id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_card": {
+ "allOf": [
+ {
+ "title": "Project Card",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer"
+ },
+ "column_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "id": {
+ "description": "The project card's ID",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "column_url",
+ "column_id",
+ "id",
+ "node_id",
+ "note",
+ "archived",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "number",
+ "nullable": true
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "column_id": {
+ "type": "integer"
+ },
+ "column_url": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "creator": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "note": {
+ "type": "string",
+ "nullable": true
+ },
+ "project_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "after_id"
+ ]
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_card",
+ "sender"
+ ]
+ },
+ "webhook-project-closed": {
+ "title": "project closed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "Body of the project",
+ "type": "string",
+ "nullable": true
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "owner_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project",
+ "sender"
+ ]
+ },
+ "webhook-project-column-created": {
+ "title": "project_column created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_column": {
+ "title": "Project Column",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "description": "The unique identifier of the project column",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project column",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "cards_url",
+ "id",
+ "node_id",
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_column"
+ ]
+ },
+ "webhook-project-column-deleted": {
+ "title": "project_column deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_column": {
+ "title": "Project Column",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "description": "The unique identifier of the project column",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project column",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "cards_url",
+ "id",
+ "node_id",
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_column"
+ ]
+ },
+ "webhook-project-column-edited": {
+ "title": "project_column edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_column": {
+ "title": "Project Column",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "description": "The unique identifier of the project column",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project column",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "cards_url",
+ "id",
+ "node_id",
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "project_column"
+ ]
+ },
+ "webhook-project-column-moved": {
+ "title": "project_column moved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "moved"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project_column": {
+ "title": "Project Column",
+ "type": "object",
+ "properties": {
+ "after_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "description": "The unique identifier of the project column",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project column",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "project_url",
+ "cards_url",
+ "id",
+ "node_id",
+ "name",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project_column",
+ "sender"
+ ]
+ },
+ "webhook-project-created": {
+ "title": "project created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "Body of the project",
+ "type": "string",
+ "nullable": true
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "owner_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project",
+ "sender"
+ ]
+ },
+ "webhook-project-deleted": {
+ "title": "project deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "Body of the project",
+ "type": "string",
+ "nullable": true
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "owner_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project"
+ ]
+ },
+ "webhook-project-edited": {
+ "title": "project edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the project if the action was `edited`.",
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The changes to the project if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "Body of the project",
+ "type": "string",
+ "nullable": true
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "owner_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project"
+ ]
+ },
+ "webhook-project-reopened": {
+ "title": "project reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "Body of the project",
+ "type": "string",
+ "nullable": true
+ },
+ "columns_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the project",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "owner_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "project",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-project-closed": {
+ "title": "Projects v2 Project Closed Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2": {
+ "$ref": "#/components/schemas/projects-v2"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-project-created": {
+ "description": "A project was created",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2": {
+ "$ref": "#/components/schemas/projects-v2"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-project-deleted": {
+ "title": "Projects v2 Project Deleted Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2": {
+ "$ref": "#/components/schemas/projects-v2"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-project-edited": {
+ "title": "Projects v2 Project Edited Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "public": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "boolean"
+ },
+ "to": {
+ "type": "boolean"
+ }
+ }
+ },
+ "short_description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "title": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2": {
+ "$ref": "#/components/schemas/projects-v2"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2",
+ "organization",
+ "sender",
+ "changes"
+ ]
+ },
+ "webhook-projects-v2-item-archived": {
+ "title": "Projects v2 Item Archived Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "archived"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "archived_at": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "to": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ }
+ }
+ }
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender",
+ "changes"
+ ]
+ },
+ "webhook-projects-v2-item-converted": {
+ "title": "Projects v2 Item Converted Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "converted"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender",
+ "changes"
+ ]
+ },
+ "webhook-projects-v2-item-created": {
+ "title": "Projects v2 Item Created Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-item-deleted": {
+ "title": "Projects v2 Item Deleted Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-item-edited": {
+ "title": "Projects v2 Item Edited Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "field_value": {
+ "type": "object",
+ "properties": {
+ "field_node_id": {
+ "type": "string"
+ },
+ "field_type": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "field_value"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "required": [
+ "body"
+ ]
+ }
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-projects-v2-item-reordered": {
+ "title": "Projects v2 Item Reordered Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reordered"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "previous_projects_v2_item_node_id": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ },
+ "to": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender",
+ "changes"
+ ]
+ },
+ "webhook-projects-v2-item-restored": {
+ "title": "Projects v2 Item Restored Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "restored"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "archived_at": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "to": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ }
+ }
+ }
+ }
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2_item": {
+ "$ref": "#/components/schemas/projects-v2-item"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2_item",
+ "organization",
+ "sender",
+ "changes"
+ ]
+ },
+ "webhook-projects-v2-project-reopened": {
+ "title": "Projects v2 Project Reopened Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "projects_v2": {
+ "$ref": "#/components/schemas/projects-v2"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "projects_v2",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-public": {
+ "title": "public event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-assigned": {
+ "title": "pull_request assigned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "assigned"
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "assignee",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-auto-merge-disabled": {
+ "title": "pull_request auto_merge_disabled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "auto_merge_disabled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "reason": {
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "reason",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-auto-merge-enabled": {
+ "title": "pull_request auto_merge_enabled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "auto_merge_enabled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "reason": {
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-closed": {
+ "title": "pull_request closed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "closed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-converted-to-draft": {
+ "title": "pull_request converted_to_draft event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "converted_to_draft"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-demilestoned": {
+ "title": "pull_request demilestoned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "demilestoned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/milestone"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-dequeued": {
+ "title": "pull_request dequeued event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "dequeued"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "reason": {
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender",
+ "reason"
+ ]
+ },
+ "webhook-pull-request-edited": {
+ "title": "pull_request edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the comment if the action was `edited`.",
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "sha": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "ref",
+ "sha"
+ ]
+ },
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "title": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the title if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "number",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-enqueued": {
+ "title": "pull_request enqueued event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "enqueued"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_discussions",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-labeled": {
+ "title": "pull_request labeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "labeled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-locked": {
+ "title": "pull_request locked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "locked"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-milestoned": {
+ "title": "pull_request milestoned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "milestoned"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "milestone": {
+ "$ref": "#/components/schemas/milestone"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-opened": {
+ "title": "pull_request opened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "opened"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-ready-for-review": {
+ "title": "pull_request ready_for_review event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "ready_for_review"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-reopened": {
+ "title": "pull_request reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/pull-request"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_update_branch": {
+ "description": "Whether to allow updating the pull request's branch.",
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged.",
+ "type": "boolean",
+ "default": false
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**",
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-comment-created": {
+ "title": "pull_request_review_comment created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "comment": {
+ "title": "Pull Request Review Comment",
+ "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "type": "integer"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "type": "string"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies.",
+ "type": "integer"
+ },
+ "original_start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "start_side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ null
+ ],
+ "default": "RIGHT"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the pull request review comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "pull_request_review_id",
+ "id",
+ "node_id",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links",
+ "start_line",
+ "original_start_line",
+ "original_line",
+ "line",
+ "start_side",
+ "side",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "comment",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-comment-deleted": {
+ "title": "pull_request_review_comment deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "comment": {
+ "title": "Pull Request Review Comment",
+ "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "type": "integer"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "type": "string"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer"
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies.",
+ "type": "integer"
+ },
+ "original_start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "start_side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ null
+ ],
+ "default": "RIGHT"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the pull request review comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "pull_request_review_id",
+ "id",
+ "node_id",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links",
+ "start_line",
+ "original_start_line",
+ "original_line",
+ "line",
+ "start_side",
+ "side",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "comment",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-comment-edited": {
+ "title": "pull_request_review_comment edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the comment.",
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "comment": {
+ "title": "Pull Request Review Comment",
+ "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "type": "integer"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "type": "string"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer"
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies.",
+ "type": "integer"
+ },
+ "original_start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "start_side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ null
+ ],
+ "default": "RIGHT"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the pull request review comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "pull_request_review_id",
+ "id",
+ "node_id",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links",
+ "start_line",
+ "original_start_line",
+ "original_line",
+ "line",
+ "start_side",
+ "side",
+ "reactions"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "comment",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-dismissed": {
+ "title": "pull_request_review dismissed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "dismissed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Simple Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "draft",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "review": {
+ "description": "The review that was affected.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the review.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_id": {
+ "description": "A commit SHA for the review.",
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the review",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "dismissed",
+ "approved",
+ "changes_requested"
+ ]
+ },
+ "submitted_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "commit_id",
+ "submitted_at",
+ "state",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "review",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-edited": {
+ "title": "pull_request_review edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Simple Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "draft",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "review": {
+ "description": "The review that was affected.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the review.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_id": {
+ "description": "A commit SHA for the review.",
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the review",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string"
+ },
+ "submitted_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "commit_id",
+ "submitted_at",
+ "state",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "review",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-request-removed": {
+ "title": "pull_request review_request_removed event",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "review_request_removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title.",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requested_reviewer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "requested_reviewer",
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "review_request_removed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requested_team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "requested_team",
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ }
+ ]
+ },
+ "webhook-pull-request-review-requested": {
+ "title": "pull_request review_requested event",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "review_requested"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requested_reviewer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "requested_reviewer",
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "review_requested"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "requested_team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "requested_team",
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ }
+ ]
+ },
+ "webhook-pull-request-review-submitted": {
+ "title": "pull_request_review submitted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "submitted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Simple Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "draft",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "review": {
+ "description": "The review that was affected.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the review.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_id": {
+ "description": "A commit SHA for the review.",
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the review",
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "pull_request_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string"
+ },
+ "submitted_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "user",
+ "body",
+ "commit_id",
+ "submitted_at",
+ "state",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "review",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-review-thread-resolved": {
+ "title": "pull_request_review_thread resolved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "resolved"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Simple Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "draft",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "thread": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "type": "array",
+ "items": {
+ "title": "Pull Request Review Comment",
+ "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "type": "integer"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "type": "string"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies.",
+ "type": "integer"
+ },
+ "original_start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "start_side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ null
+ ],
+ "default": "RIGHT"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the pull request review comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "pull_request_review_id",
+ "id",
+ "node_id",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links",
+ "start_line",
+ "original_start_line",
+ "original_line",
+ "line",
+ "start_side",
+ "side",
+ "reactions"
+ ]
+ }
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "comments"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "thread",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-review-thread-unresolved": {
+ "title": "pull_request_review_thread unresolved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unresolved"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Simple Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string"
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "draft",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "thread": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "type": "array",
+ "items": {
+ "title": "Pull Request Review Comment",
+ "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "pull_request"
+ ]
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "body": {
+ "description": "The text of the comment.",
+ "type": "string"
+ },
+ "commit_id": {
+ "description": "The SHA of the commit to which the comment applies.",
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "diff_hunk": {
+ "description": "The diff of the line that the comment refers to.",
+ "type": "string"
+ },
+ "html_url": {
+ "description": "HTML URL for the pull request review comment.",
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "The ID of the pull request review comment.",
+ "type": "integer"
+ },
+ "in_reply_to_id": {
+ "description": "The comment ID to reply to.",
+ "type": "integer"
+ },
+ "line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer",
+ "nullable": true
+ },
+ "node_id": {
+ "description": "The node ID of the pull request review comment.",
+ "type": "string"
+ },
+ "original_commit_id": {
+ "description": "The SHA of the original commit to which the comment applies.",
+ "type": "string"
+ },
+ "original_line": {
+ "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
+ "type": "integer"
+ },
+ "original_position": {
+ "description": "The index of the original line in the diff to which the comment applies.",
+ "type": "integer"
+ },
+ "original_start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "path": {
+ "description": "The relative path of the file to which the comment applies.",
+ "type": "string"
+ },
+ "position": {
+ "description": "The line index in the diff to which the comment applies.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_review_id": {
+ "description": "The ID of the pull request review to which the comment belongs.",
+ "type": "integer",
+ "nullable": true
+ },
+ "pull_request_url": {
+ "description": "URL for the pull request that the review comment belongs to.",
+ "type": "string",
+ "format": "uri"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "enum": [
+ "LEFT",
+ "RIGHT"
+ ]
+ },
+ "start_line": {
+ "description": "The first line of the range for a multi-line comment.",
+ "type": "integer",
+ "nullable": true
+ },
+ "start_side": {
+ "description": "The side of the first line of the range for a multi-line comment.",
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "LEFT",
+ "RIGHT",
+ null
+ ],
+ "default": "RIGHT"
+ },
+ "subject_type": {
+ "description": "The level at which the comment is targeted, can be a diff line or a file.",
+ "type": "string",
+ "enum": [
+ "line",
+ "file"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "description": "URL for the pull request review comment",
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "pull_request_review_id",
+ "id",
+ "node_id",
+ "diff_hunk",
+ "path",
+ "position",
+ "original_position",
+ "commit_id",
+ "original_commit_id",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "html_url",
+ "pull_request_url",
+ "author_association",
+ "_links",
+ "start_line",
+ "original_start_line",
+ "original_line",
+ "line",
+ "start_side",
+ "side",
+ "reactions"
+ ]
+ }
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "comments"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "thread",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-synchronize": {
+ "title": "pull_request synchronize event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "synchronize"
+ ]
+ },
+ "after": {
+ "type": "string"
+ },
+ "before": {
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit message title.",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "before",
+ "after",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-unassigned": {
+ "title": "pull_request unassigned event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unassigned"
+ ]
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository"
+ ]
+ },
+ "webhook-pull-request-unlabeled": {
+ "title": "pull_request unlabeled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlabeled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "label": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string",
+ "nullable": true
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit message title.",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization",
+ "Mannequin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-pull-request-unlocked": {
+ "title": "pull_request unlocked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unlocked"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "number": {
+ "description": "The pull request number.",
+ "type": "integer"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pull_request": {
+ "title": "Pull Request",
+ "type": "object",
+ "properties": {
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "format": "uri-template"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "required": [
+ "self",
+ "html",
+ "issue",
+ "comments",
+ "review_comments",
+ "review_comment",
+ "commits",
+ "statuses"
+ ]
+ },
+ "active_lock_reason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "resolved",
+ "off-topic",
+ "too heated",
+ "spam",
+ null
+ ]
+ },
+ "additions": {
+ "type": "integer"
+ },
+ "assignee": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "author_association": {
+ "title": "AuthorAssociation",
+ "description": "How the author is associated with the repository.",
+ "type": "string",
+ "enum": [
+ "COLLABORATOR",
+ "CONTRIBUTOR",
+ "FIRST_TIMER",
+ "FIRST_TIME_CONTRIBUTOR",
+ "MANNEQUIN",
+ "MEMBER",
+ "NONE",
+ "OWNER"
+ ]
+ },
+ "auto_merge": {
+ "title": "PullRequestAutoMerge",
+ "description": "The status of auto merging a pull request.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "commit_message": {
+ "description": "Commit message for the merge commit.",
+ "type": "string",
+ "nullable": true
+ },
+ "commit_title": {
+ "description": "Title for the merge commit message.",
+ "type": "string"
+ },
+ "enabled_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "merge_method": {
+ "description": "The merge method to use.",
+ "type": "string",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ "required": [
+ "enabled_by",
+ "merge_method",
+ "commit_title",
+ "commit_message"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "changed_files": {
+ "type": "integer"
+ },
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "comments": {
+ "type": "integer"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commits": {
+ "type": "integer"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "deletions": {
+ "type": "integer"
+ },
+ "diff_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Indicates whether or not the pull request is a draft.",
+ "type": "boolean"
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merge_commit_message": {
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "PR_TITLE",
+ "BLANK"
+ ]
+ },
+ "merge_commit_title": {
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "MERGE_MESSAGE"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "squash_merge_commit_message": {
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
+ "type": "string",
+ "enum": [
+ "PR_BODY",
+ "COMMIT_MESSAGES",
+ "BLANK"
+ ]
+ },
+ "squash_merge_commit_title": {
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
+ "type": "string",
+ "enum": [
+ "PR_TITLE",
+ "COMMIT_OR_PR_TITLE"
+ ]
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "use_squash_pr_title_as_default": {
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+ "type": "boolean",
+ "default": false
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "sha",
+ "user",
+ "repo"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "title": "Label",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "6-character hex code, without the leading #, identifying the color",
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the label.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the label",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description"
+ ]
+ }
+ },
+ "locked": {
+ "type": "boolean"
+ },
+ "maintainer_can_modify": {
+ "description": "Indicates whether maintainers can modify the pull request.",
+ "type": "boolean"
+ },
+ "merge_commit_sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "mergeable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "mergeable_state": {
+ "type": "string"
+ },
+ "merged": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merged_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "merged_by": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "milestone": {
+ "title": "Milestone",
+ "description": "A collection of related issues and pull requests.",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "closed_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "closed_issues": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "creator": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "due_on": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of the milestone.",
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "The state of the milestone.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "title": {
+ "description": "The title of the milestone.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "labels_url",
+ "id",
+ "node_id",
+ "number",
+ "title",
+ "description",
+ "creator",
+ "open_issues",
+ "closed_issues",
+ "state",
+ "created_at",
+ "updated_at",
+ "due_on",
+ "closed_at"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "description": "Number uniquely identifying the pull request within its repository.",
+ "type": "integer"
+ },
+ "patch_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rebaseable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ ]
+ }
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "review_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "review_comments": {
+ "type": "integer"
+ },
+ "review_comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "state": {
+ "description": "State of this Pull Request. Either `open` or `closed`.",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "title": {
+ "description": "The title of the pull request.",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "node_id",
+ "html_url",
+ "diff_url",
+ "patch_url",
+ "issue_url",
+ "number",
+ "state",
+ "locked",
+ "title",
+ "user",
+ "body",
+ "created_at",
+ "updated_at",
+ "closed_at",
+ "merged_at",
+ "merge_commit_sha",
+ "assignee",
+ "assignees",
+ "requested_reviewers",
+ "requested_teams",
+ "labels",
+ "milestone",
+ "commits_url",
+ "review_comments_url",
+ "review_comment_url",
+ "comments_url",
+ "statuses_url",
+ "head",
+ "base",
+ "_links",
+ "author_association",
+ "auto_merge",
+ "active_lock_reason",
+ "draft"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "number",
+ "pull_request",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-push": {
+ "title": "push event",
+ "type": "object",
+ "properties": {
+ "after": {
+ "description": "The SHA of the most recent commit on `ref` after the push.",
+ "type": "string"
+ },
+ "base_ref": {
+ "type": "string",
+ "nullable": true
+ },
+ "before": {
+ "description": "The SHA of the most recent commit on `ref` before the push.",
+ "type": "string"
+ },
+ "commits": {
+ "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.",
+ "type": "array",
+ "items": {
+ "title": "Commit",
+ "type": "object",
+ "properties": {
+ "added": {
+ "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "distinct": {
+ "description": "Whether this commit is distinct from any that have been pushed before.",
+ "type": "boolean"
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "description": "The commit message.",
+ "type": "string"
+ },
+ "modified": {
+ "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "removed": {
+ "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "timestamp": {
+ "description": "The ISO 8601 timestamp of the commit.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "tree_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL that points to the commit API resource.",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "distinct",
+ "message",
+ "timestamp",
+ "url",
+ "author",
+ "committer"
+ ]
+ }
+ },
+ "compare": {
+ "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.",
+ "type": "string"
+ },
+ "created": {
+ "description": "Whether this push created the `ref`.",
+ "type": "boolean"
+ },
+ "deleted": {
+ "description": "Whether this push deleted the `ref`.",
+ "type": "boolean"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "forced": {
+ "description": "Whether this push was a force push of the `ref`.",
+ "type": "boolean"
+ },
+ "head_commit": {
+ "title": "Commit",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "added": {
+ "description": "An array of files added in the commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "distinct": {
+ "description": "Whether this commit is distinct from any that have been pushed before.",
+ "type": "boolean"
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "description": "The commit message.",
+ "type": "string"
+ },
+ "modified": {
+ "description": "An array of files modified by the commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "removed": {
+ "description": "An array of files removed in the commit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "timestamp": {
+ "description": "The ISO 8601 timestamp of the commit.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "tree_id": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL that points to the commit API resource.",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "distinct",
+ "message",
+ "timestamp",
+ "url",
+ "author",
+ "committer"
+ ]
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "pusher": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "ref": {
+ "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.",
+ "type": "string"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_discussions": {
+ "description": "Whether discussions are enabled.",
+ "type": "boolean",
+ "default": false
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "has_discussions",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "ref",
+ "before",
+ "after",
+ "created",
+ "deleted",
+ "forced",
+ "base_ref",
+ "compare",
+ "commits",
+ "head_commit",
+ "repository",
+ "pusher"
+ ]
+ },
+ "webhook-registry-package-published": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "published"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "registry_package": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "ecosystem": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "namespace": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "avatar_url",
+ "gravatar_id",
+ "url",
+ "html_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "starred_url",
+ "subscriptions_url",
+ "organizations_url",
+ "repos_url",
+ "events_url",
+ "received_events_url",
+ "type",
+ "site_admin"
+ ]
+ },
+ "package_type": {
+ "type": "string"
+ },
+ "package_version": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "avatar_url",
+ "gravatar_id",
+ "url",
+ "html_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "starred_url",
+ "subscriptions_url",
+ "organizations_url",
+ "repos_url",
+ "events_url",
+ "received_events_url",
+ "type",
+ "site_admin"
+ ]
+ },
+ "body": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "container_metadata": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "object",
+ "nullable": true
+ },
+ "manifest": {
+ "type": "object",
+ "nullable": true
+ },
+ "tag": {
+ "type": "object",
+ "properties": {
+ "digest": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "docker_metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "manifest": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "npm_metadata": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ },
+ "npm_user": {
+ "type": "string"
+ },
+ "author": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "bugs": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "dependencies": {
+ "type": "object"
+ },
+ "dev_dependencies": {
+ "type": "object"
+ },
+ "peer_dependencies": {
+ "type": "object"
+ },
+ "optional_dependencies": {
+ "type": "object"
+ },
+ "description": {
+ "type": "string"
+ },
+ "dist": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "git_head": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string"
+ },
+ "license": {
+ "type": "string"
+ },
+ "main": {
+ "type": "string"
+ },
+ "repository": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "scripts": {
+ "type": "object"
+ },
+ "id": {
+ "type": "string"
+ },
+ "node_version": {
+ "type": "string"
+ },
+ "npm_version": {
+ "type": "string"
+ },
+ "has_shrinkwrap": {
+ "type": "boolean"
+ },
+ "maintainers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "contributors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "engines": {
+ "type": "object"
+ },
+ "keywords": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "files": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "bin": {
+ "type": "object"
+ },
+ "man": {
+ "type": "object"
+ },
+ "directories": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "nullable": true
+ },
+ "os": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cpu": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "readme": {
+ "type": "string"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "release_id": {
+ "type": "integer"
+ },
+ "commit_oid": {
+ "type": "string"
+ },
+ "published_via_actions": {
+ "type": "boolean"
+ },
+ "deleted_by_id": {
+ "type": "integer"
+ }
+ }
+ },
+ "nuget_metadata": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "object"
+ },
+ {
+ "type": "integer"
+ }
+ ],
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "branch": {
+ "type": "string"
+ },
+ "commit": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "package_files": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "md5": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string",
+ "nullable": true
+ },
+ "sha256": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "download_url",
+ "id",
+ "name",
+ "sha256",
+ "sha1",
+ "md5",
+ "content_type",
+ "state",
+ "size",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "package_url": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "release": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rubygems_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
+ }
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "target_oid": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "version",
+ "name",
+ "description",
+ "summary",
+ "html_url",
+ "metadata",
+ "package_files",
+ "installation_command",
+ "package_url"
+ ]
+ },
+ "registry": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "about_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "vendor": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "namespace",
+ "description",
+ "ecosystem",
+ "package_type",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "owner",
+ "package_version",
+ "registry"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "registry_package",
+ "sender"
+ ]
+ },
+ "webhook-registry-package-updated": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "updated"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "registry_package": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "nullable": true
+ },
+ "ecosystem": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "namespace": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "avatar_url",
+ "gravatar_id",
+ "url",
+ "html_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "starred_url",
+ "subscriptions_url",
+ "organizations_url",
+ "repos_url",
+ "events_url",
+ "received_events_url",
+ "type",
+ "site_admin"
+ ]
+ },
+ "package_type": {
+ "type": "string"
+ },
+ "package_version": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "avatar_url",
+ "gravatar_id",
+ "url",
+ "html_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "starred_url",
+ "subscriptions_url",
+ "organizations_url",
+ "repos_url",
+ "events_url",
+ "received_events_url",
+ "type",
+ "site_admin"
+ ]
+ },
+ "body": {
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "docker_metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "installation_command": {
+ "type": "string"
+ },
+ "manifest": {
+ "type": "string"
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "package_files": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "download_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "md5": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string",
+ "nullable": true
+ },
+ "sha256": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "package_url": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "release": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "avatar_url",
+ "gravatar_id",
+ "url",
+ "html_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "starred_url",
+ "subscriptions_url",
+ "organizations_url",
+ "repos_url",
+ "events_url",
+ "received_events_url",
+ "type",
+ "site_admin"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at"
+ ]
+ },
+ "rubygems_metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
+ }
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "target_oid": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "version",
+ "name",
+ "description",
+ "summary",
+ "body",
+ "body_html",
+ "html_url",
+ "target_commitish",
+ "target_oid",
+ "created_at",
+ "updated_at",
+ "metadata",
+ "package_files",
+ "author",
+ "installation_command",
+ "package_url"
+ ]
+ },
+ "registry": {
+ "type": "object",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "namespace",
+ "description",
+ "ecosystem",
+ "package_type",
+ "html_url",
+ "created_at",
+ "updated_at",
+ "owner",
+ "package_version",
+ "registry"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "registry_package",
+ "sender"
+ ]
+ },
+ "webhook-release-created": {
+ "title": "release created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-release-deleted": {
+ "title": "release deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-release-edited": {
+ "title": "release edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the body if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the name if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "make_latest": {
+ "type": "object",
+ "properties": {
+ "to": {
+ "description": "Whether this release was explicitly `edited` to be the latest.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "to"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "release",
+ "repository"
+ ]
+ },
+ "webhook-release-prereleased": {
+ "title": "release prereleased event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "prereleased"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "allOf": [
+ {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "assets_url": {
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean",
+ "enum": [
+ true
+ ]
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "prerelease"
+ ]
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository"
+ ]
+ },
+ "webhook-release-published": {
+ "title": "release published event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "published"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "allOf": [
+ {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "assets_url": {
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "published_at"
+ ]
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository"
+ ]
+ },
+ "webhook-release-released": {
+ "title": "release released event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "released"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository"
+ ]
+ },
+ "webhook-release-unpublished": {
+ "title": "release unpublished event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unpublished"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "release": {
+ "allOf": [
+ {
+ "title": "Release",
+ "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.",
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "title": "Release Asset",
+ "description": "Data related to a release.",
+ "type": "object",
+ "properties": {
+ "browser_download_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "download_count": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "label": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "description": "The file name of the asset.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "state": {
+ "description": "State of the release asset.",
+ "type": "string",
+ "enum": [
+ "uploaded"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "uploader": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "browser_download_url",
+ "id",
+ "node_id",
+ "name",
+ "label",
+ "state",
+ "content_type",
+ "size",
+ "download_count",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "assets_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "discussion_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "draft": {
+ "description": "Whether the release is a draft or published",
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "description": "Whether the release is identified as a prerelease or a full release.",
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "reactions": {
+ "title": "Reactions",
+ "type": "object",
+ "properties": {
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ },
+ "tag_name": {
+ "description": "The name of the tag.",
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "target_commitish": {
+ "description": "Specifies the commitish value that determines where the Git tag is created from.",
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "assets_url",
+ "upload_url",
+ "html_url",
+ "id",
+ "node_id",
+ "tag_name",
+ "target_commitish",
+ "name",
+ "draft",
+ "author",
+ "prerelease",
+ "created_at",
+ "published_at",
+ "assets",
+ "tarball_url",
+ "zipball_url",
+ "body"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "assets": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "assets_url": {
+ "type": "string"
+ },
+ "author": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "draft": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "prerelease": {
+ "type": "boolean"
+ },
+ "published_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "tag_name": {
+ "type": "string"
+ },
+ "tarball_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "target_commitish": {
+ "type": "string"
+ },
+ "upload_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "zipball_url": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "published_at"
+ ]
+ }
+ ]
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "release",
+ "repository"
+ ]
+ },
+ "webhook-repository-advisory-published": {
+ "title": "Repository advisory published event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "published"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_advisory": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "repository_advisory"
+ ]
+ },
+ "webhook-repository-advisory-reported": {
+ "title": "Repository advisory reported event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reported"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_advisory": {
+ "$ref": "#/components/schemas/repository-advisory"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "repository_advisory"
+ ]
+ },
+ "webhook-repository-archived": {
+ "title": "repository archived event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "archived"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-created": {
+ "title": "repository created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-deleted": {
+ "title": "repository deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-dispatch-sample": {
+ "title": "repository_dispatch event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "sample.collected"
+ ]
+ },
+ "branch": {
+ "type": "string"
+ },
+ "client_payload": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "branch",
+ "client_payload",
+ "repository",
+ "sender",
+ "installation"
+ ]
+ },
+ "webhook-repository-edited": {
+ "title": "repository edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "default_branch": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "homepage": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "topics": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-import": {
+ "title": "repository_import event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "success",
+ "cancelled",
+ "failure"
+ ]
+ }
+ },
+ "required": [
+ "status",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-privatized": {
+ "title": "repository privatized event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "privatized"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-publicized": {
+ "title": "repository publicized event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "publicized"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-renamed": {
+ "title": "repository renamed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "renamed"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "repository": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ },
+ "required": [
+ "repository"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-ruleset-created": {
+ "title": "repository ruleset created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_ruleset": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository_ruleset",
+ "sender"
+ ]
+ },
+ "webhook-repository-ruleset-deleted": {
+ "title": "repository ruleset deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_ruleset": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository_ruleset",
+ "sender"
+ ]
+ },
+ "webhook-repository-ruleset-edited": {
+ "title": "repository ruleset edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "repository_ruleset": {
+ "$ref": "#/components/schemas/repository-ruleset"
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "enforcement": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "conditions": {
+ "type": "object",
+ "properties": {
+ "added": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ }
+ },
+ "deleted": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ }
+ },
+ "updated": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "condition": {
+ "$ref": "#/components/schemas/repository-ruleset-conditions"
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "condition_type": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "target": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "include": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "exclude": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "rules": {
+ "type": "object",
+ "properties": {
+ "added": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ },
+ "deleted": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/repository-rule"
+ }
+ },
+ "updated": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "#/components/schemas/repository-rule"
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "configuration": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "rule_type": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ },
+ "pattern": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository_ruleset",
+ "sender"
+ ]
+ },
+ "webhook-repository-transferred": {
+ "title": "repository transferred event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "transferred"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "owner": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "object",
+ "properties": {
+ "organization": {
+ "title": "Organization",
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "login": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "public_members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id",
+ "node_id",
+ "url",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description"
+ ]
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ }
+ }
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "owner"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-unarchived": {
+ "title": "repository unarchived event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "unarchived"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-vulnerability-alert-create": {
+ "title": "repository_vulnerability_alert create event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "create"
+ ]
+ },
+ "alert": {
+ "allOf": [
+ {
+ "title": "Repository Vulnerability Alert Alert",
+ "description": "The security alert of the vulnerable dependency.",
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "dismiss_reason": {
+ "type": "string"
+ },
+ "dismissed_at": {
+ "type": "string"
+ },
+ "dismisser": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "fix_reason": {
+ "type": "string"
+ },
+ "fixed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "number",
+ "node_id",
+ "state",
+ "affected_range",
+ "affected_package_name",
+ "ghsa_id",
+ "severity",
+ "external_reference",
+ "external_identifier",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open"
+ ]
+ }
+ },
+ "required": [
+ "state"
+ ]
+ }
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-vulnerability-alert-dismiss": {
+ "title": "repository_vulnerability_alert dismiss event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "dismiss"
+ ]
+ },
+ "alert": {
+ "allOf": [
+ {
+ "title": "Repository Vulnerability Alert Alert",
+ "description": "The security alert of the vulnerable dependency.",
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "dismiss_comment": {
+ "type": "string",
+ "nullable": true
+ },
+ "dismiss_reason": {
+ "type": "string"
+ },
+ "dismissed_at": {
+ "type": "string"
+ },
+ "dismisser": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "fix_reason": {
+ "type": "string"
+ },
+ "fixed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "number",
+ "node_id",
+ "state",
+ "affected_range",
+ "affected_package_name",
+ "ghsa_id",
+ "severity",
+ "external_reference",
+ "external_identifier",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "dismiss_comment": {
+ "type": "string",
+ "nullable": true
+ },
+ "dismiss_reason": {
+ "type": "string"
+ },
+ "dismissed_at": {
+ "type": "string"
+ },
+ "dismisser": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "dismissed"
+ ]
+ }
+ },
+ "required": [
+ "dismisser",
+ "dismiss_reason",
+ "dismissed_at",
+ "state"
+ ]
+ }
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-vulnerability-alert-reopen": {
+ "title": "repository_vulnerability_alert reopen event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopen"
+ ]
+ },
+ "alert": {
+ "allOf": [
+ {
+ "title": "Repository Vulnerability Alert Alert",
+ "description": "The security alert of the vulnerable dependency.",
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "dismiss_reason": {
+ "type": "string"
+ },
+ "dismissed_at": {
+ "type": "string"
+ },
+ "dismisser": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "fix_reason": {
+ "type": "string"
+ },
+ "fixed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "number",
+ "node_id",
+ "state",
+ "affected_range",
+ "affected_package_name",
+ "ghsa_id",
+ "severity",
+ "external_reference",
+ "external_identifier",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open"
+ ]
+ }
+ },
+ "required": [
+ "state"
+ ]
+ }
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-repository-vulnerability-alert-resolve": {
+ "title": "repository_vulnerability_alert resolve event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "resolve"
+ ]
+ },
+ "alert": {
+ "allOf": [
+ {
+ "title": "Repository Vulnerability Alert Alert",
+ "description": "The security alert of the vulnerable dependency.",
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "dismiss_reason": {
+ "type": "string"
+ },
+ "dismissed_at": {
+ "type": "string"
+ },
+ "dismisser": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "fix_reason": {
+ "type": "string"
+ },
+ "fixed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "open",
+ "dismissed",
+ "fixed"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "number",
+ "node_id",
+ "state",
+ "affected_range",
+ "affected_package_name",
+ "ghsa_id",
+ "severity",
+ "external_reference",
+ "external_identifier",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "affected_package_name": {
+ "type": "string"
+ },
+ "affected_range": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "external_identifier": {
+ "type": "string"
+ },
+ "external_reference": {
+ "type": "string",
+ "nullable": true
+ },
+ "fix_reason": {
+ "type": "string"
+ },
+ "fixed_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fixed_in": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "severity": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "fixed",
+ "open"
+ ]
+ }
+ },
+ "required": [
+ "state"
+ ]
+ }
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-secret-scanning-alert-created": {
+ "title": "secret_scanning_alert created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository"
+ ]
+ },
+ "webhook-secret-scanning-alert-location-created": {
+ "title": "Secret Scanning Alert Location Created Event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "location": {
+ "$ref": "#/components/schemas/secret-scanning-location"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "location",
+ "alert",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-secret-scanning-alert-location-created-form-encoded": {
+ "title": "Secret Scanning Alert Location Created Event",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "payload"
+ ]
+ },
+ "webhook-secret-scanning-alert-reopened": {
+ "title": "secret_scanning_alert reopened event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "reopened"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository"
+ ]
+ },
+ "webhook-secret-scanning-alert-resolved": {
+ "title": "secret_scanning_alert resolved event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "resolved"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository"
+ ]
+ },
+ "webhook-secret-scanning-alert-revoked": {
+ "title": "secret_scanning_alert revoked event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "revoked"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository"
+ ]
+ },
+ "webhook-secret-scanning-alert-validated": {
+ "title": "secret_scanning_alert validated event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "validated"
+ ]
+ },
+ "alert": {
+ "$ref": "#/components/schemas/secret-scanning-alert-webhook"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "alert",
+ "repository"
+ ]
+ },
+ "webhook-security-advisory-published": {
+ "title": "security_advisory published event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "published"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "security_advisory": {
+ "description": "The details of the security advisory, including summary, description, and severity.",
+ "type": "object",
+ "properties": {
+ "cvss": {
+ "type": "object",
+ "properties": {
+ "score": {
+ "type": "number"
+ },
+ "vector_string": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value",
+ "type"
+ ]
+ }
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url"
+ ]
+ }
+ },
+ "severity": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "first_patched_version": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "identifier": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "identifier"
+ ]
+ },
+ "package": {
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "severity": {
+ "type": "string"
+ },
+ "vulnerable_version_range": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "package",
+ "severity",
+ "vulnerable_version_range",
+ "first_patched_version"
+ ]
+ }
+ },
+ "withdrawn_at": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "cvss",
+ "cwes",
+ "ghsa_id",
+ "summary",
+ "description",
+ "severity",
+ "identifiers",
+ "references",
+ "published_at",
+ "updated_at",
+ "withdrawn_at",
+ "vulnerabilities"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "security_advisory"
+ ]
+ },
+ "webhook-security-advisory-updated": {
+ "title": "security_advisory updated event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "updated"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "security_advisory": {
+ "description": "The details of the security advisory, including summary, description, and severity.",
+ "type": "object",
+ "properties": {
+ "cvss": {
+ "type": "object",
+ "properties": {
+ "score": {
+ "type": "number"
+ },
+ "vector_string": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value",
+ "type"
+ ]
+ }
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url"
+ ]
+ }
+ },
+ "severity": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "first_patched_version": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "identifier": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "identifier"
+ ]
+ },
+ "package": {
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "severity": {
+ "type": "string"
+ },
+ "vulnerable_version_range": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "package",
+ "severity",
+ "vulnerable_version_range",
+ "first_patched_version"
+ ]
+ }
+ },
+ "withdrawn_at": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "cvss",
+ "cwes",
+ "ghsa_id",
+ "summary",
+ "description",
+ "severity",
+ "identifiers",
+ "references",
+ "published_at",
+ "updated_at",
+ "withdrawn_at",
+ "vulnerabilities"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "security_advisory"
+ ]
+ },
+ "webhook-security-advisory-withdrawn": {
+ "title": "security_advisory withdrawn event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "withdrawn"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "security_advisory": {
+ "description": "The details of the security advisory, including summary, description, and severity.",
+ "type": "object",
+ "properties": {
+ "cvss": {
+ "type": "object",
+ "properties": {
+ "score": {
+ "type": "number"
+ },
+ "vector_string": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ }
+ },
+ "description": {
+ "type": "string"
+ },
+ "ghsa_id": {
+ "type": "string"
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "value",
+ "type"
+ ]
+ }
+ },
+ "published_at": {
+ "type": "string"
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url"
+ ]
+ }
+ },
+ "severity": {
+ "type": "string"
+ },
+ "summary": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "first_patched_version": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "identifier": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "identifier"
+ ]
+ },
+ "package": {
+ "type": "object",
+ "properties": {
+ "ecosystem": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "severity": {
+ "type": "string"
+ },
+ "vulnerable_version_range": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "package",
+ "severity",
+ "vulnerable_version_range",
+ "first_patched_version"
+ ]
+ }
+ },
+ "withdrawn_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "cvss",
+ "cwes",
+ "ghsa_id",
+ "summary",
+ "description",
+ "severity",
+ "identifiers",
+ "references",
+ "published_at",
+ "updated_at",
+ "withdrawn_at",
+ "vulnerabilities"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "security_advisory"
+ ]
+ },
+ "webhook-security-and-analysis": {
+ "title": "security_and_analysis event",
+ "type": "object",
+ "properties": {
+ "changes": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "object",
+ "properties": {
+ "security_and_analysis": {
+ "$ref": "#/components/schemas/security-and-analysis"
+ }
+ }
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/full-repository"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "changes",
+ "repository"
+ ]
+ },
+ "webhook-sponsorship-cancelled": {
+ "title": "sponsorship cancelled event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "cancelled"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-sponsorship-created": {
+ "title": "sponsorship created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-sponsorship-edited": {
+ "title": "sponsorship edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "privacy_level": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-sponsorship-pending-cancellation": {
+ "title": "sponsorship pending_cancellation event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pending_cancellation"
+ ]
+ },
+ "effective_date": {
+ "description": "The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-sponsorship-pending-tier-change": {
+ "title": "sponsorship pending_tier_change event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "pending_tier_change"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "tier": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "tier"
+ ]
+ },
+ "effective_date": {
+ "description": "The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect.",
+ "type": "string"
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-sponsorship-tier-changed": {
+ "title": "sponsorship tier_changed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "tier_changed"
+ ]
+ },
+ "changes": {
+ "type": "object",
+ "properties": {
+ "tier": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "tier"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sponsorship": {
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "maintainer": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "privacy_level": {
+ "type": "string"
+ },
+ "sponsor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "sponsorable": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "tier": {
+ "title": "Sponsorship Tier",
+ "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
+ "type": "object",
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "is_custom_ammount": {
+ "type": "boolean"
+ },
+ "is_custom_amount": {
+ "type": "boolean"
+ },
+ "is_one_time": {
+ "type": "boolean"
+ },
+ "monthly_price_in_cents": {
+ "type": "integer"
+ },
+ "monthly_price_in_dollars": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "description",
+ "monthly_price_in_cents",
+ "monthly_price_in_dollars",
+ "name",
+ "is_one_time"
+ ]
+ }
+ },
+ "required": [
+ "node_id",
+ "created_at",
+ "sponsorable",
+ "sponsor",
+ "privacy_level",
+ "tier"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "sponsorship",
+ "sender"
+ ]
+ },
+ "webhook-star-created": {
+ "title": "star created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "starred_at": {
+ "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.",
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "action",
+ "starred_at",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-star-deleted": {
+ "title": "star deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "starred_at": {
+ "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "action",
+ "starred_at",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-status": {
+ "title": "status event",
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "branches": {
+ "description": "An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "protected": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name",
+ "commit",
+ "protected"
+ ]
+ }
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "allOf": [
+ {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "date"
+ ]
+ }
+ ]
+ },
+ "comment_count": {
+ "type": "integer"
+ },
+ "committer": {
+ "allOf": [
+ {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "date"
+ ]
+ }
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "tree": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "verification": {
+ "type": "object",
+ "properties": {
+ "payload": {
+ "type": "string",
+ "nullable": true
+ },
+ "reason": {
+ "type": "string",
+ "enum": [
+ "expired_key",
+ "not_signing_key",
+ "gpgverify_error",
+ "gpgverify_unavailable",
+ "unsigned",
+ "unknown_signature_type",
+ "no_user",
+ "unverified_email",
+ "bad_email",
+ "unknown_key",
+ "malformed_signature",
+ "invalid",
+ "valid",
+ "bad_cert",
+ "ocsp_pending"
+ ]
+ },
+ "signature": {
+ "type": "string",
+ "nullable": true
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "verified",
+ "reason",
+ "signature",
+ "payload"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "message",
+ "tree",
+ "url",
+ "comment_count",
+ "verification"
+ ]
+ },
+ "committer": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ }
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "html_url"
+ ]
+ }
+ },
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "node_id",
+ "commit",
+ "url",
+ "html_url",
+ "comments_url",
+ "author",
+ "committer",
+ "parents"
+ ]
+ },
+ "context": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "description": {
+ "description": "The optional human-readable description added to the status.",
+ "type": "string",
+ "nullable": true
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "id": {
+ "description": "The unique identifier of the status.",
+ "type": "integer"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "name": {
+ "type": "string"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "sha": {
+ "description": "The Commit SHA.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.",
+ "type": "string",
+ "enum": [
+ "pending",
+ "success",
+ "failure",
+ "error"
+ ]
+ },
+ "target_url": {
+ "description": "The optional link added to the status.",
+ "type": "string",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "sha",
+ "name",
+ "target_url",
+ "context",
+ "description",
+ "state",
+ "commit",
+ "branches",
+ "created_at",
+ "updated_at",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-team-add": {
+ "title": "team_add event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "team",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-team-added-to-repository": {
+ "title": "team added_to_repository event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "added_to_repository"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "team",
+ "organization"
+ ]
+ },
+ "webhook-team-created": {
+ "title": "team created event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "created"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "team",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-team-deleted": {
+ "title": "team deleted event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "deleted"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "team",
+ "organization"
+ ]
+ },
+ "webhook-team-edited": {
+ "title": "team edited event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "edited"
+ ]
+ },
+ "changes": {
+ "description": "The changes to the team if the action was `edited`.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the description if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "name": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the name if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "privacy": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the team's privacy if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "notification_setting": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The previous version of the team's notification setting if the action was `edited`.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "from"
+ ]
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "description": "The previous version of the team member's `admin` permission on a repository, if the action was `edited`.",
+ "type": "boolean"
+ },
+ "pull": {
+ "description": "The previous version of the team member's `pull` permission on a repository, if the action was `edited`.",
+ "type": "boolean"
+ },
+ "push": {
+ "description": "The previous version of the team member's `push` permission on a repository, if the action was `edited`.",
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "required": [
+ "from"
+ ]
+ }
+ },
+ "required": [
+ "permissions"
+ ]
+ }
+ }
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "changes",
+ "team",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-team-removed-from-repository": {
+ "title": "team removed_from_repository event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "removed_from_repository"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "title": "Repository",
+ "description": "A git repository",
+ "type": "object",
+ "properties": {
+ "allow_auto_merge": {
+ "description": "Whether to allow auto-merge for pull requests.",
+ "type": "boolean",
+ "default": false
+ },
+ "allow_forking": {
+ "description": "Whether to allow private forks",
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "type": "boolean",
+ "default": true
+ },
+ "allow_update_branch": {
+ "type": "boolean"
+ },
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "type": "boolean",
+ "default": false
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "clone_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "custom_properties": {
+ "type": "object",
+ "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.",
+ "additionalProperties": true
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "type": "boolean",
+ "default": false
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "disabled": {
+ "description": "Returns whether or not this repository is disabled.",
+ "type": "boolean"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "forks_count": {
+ "type": "integer"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "type": "boolean",
+ "default": true
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "license": {
+ "title": "License",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "spdx_id",
+ "url",
+ "node_id"
+ ]
+ },
+ "master_branch": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "organization": {
+ "type": "string"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "public": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "pushed_at": {
+ "nullable": true,
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "role_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "size": {
+ "type": "integer"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers": {
+ "type": "integer"
+ },
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "visibility": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "name",
+ "full_name",
+ "private",
+ "owner",
+ "html_url",
+ "description",
+ "fork",
+ "url",
+ "forks_url",
+ "keys_url",
+ "collaborators_url",
+ "teams_url",
+ "hooks_url",
+ "issue_events_url",
+ "events_url",
+ "assignees_url",
+ "branches_url",
+ "tags_url",
+ "blobs_url",
+ "git_tags_url",
+ "git_refs_url",
+ "trees_url",
+ "statuses_url",
+ "languages_url",
+ "stargazers_url",
+ "contributors_url",
+ "subscribers_url",
+ "subscription_url",
+ "commits_url",
+ "git_commits_url",
+ "comments_url",
+ "issue_comment_url",
+ "contents_url",
+ "compare_url",
+ "merges_url",
+ "archive_url",
+ "downloads_url",
+ "issues_url",
+ "pulls_url",
+ "milestones_url",
+ "notifications_url",
+ "labels_url",
+ "releases_url",
+ "deployments_url",
+ "created_at",
+ "updated_at",
+ "pushed_at",
+ "git_url",
+ "ssh_url",
+ "clone_url",
+ "svn_url",
+ "homepage",
+ "size",
+ "stargazers_count",
+ "watchers_count",
+ "language",
+ "has_issues",
+ "has_projects",
+ "has_downloads",
+ "has_wiki",
+ "has_pages",
+ "forks_count",
+ "mirror_url",
+ "archived",
+ "open_issues_count",
+ "license",
+ "forks",
+ "open_issues",
+ "watchers",
+ "default_branch",
+ "topics",
+ "visibility"
+ ]
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer"
+ },
+ "members_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id",
+ "node_id",
+ "slug",
+ "description",
+ "privacy",
+ "notification_setting",
+ "url",
+ "html_url",
+ "members_url",
+ "repositories_url",
+ "permission"
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "secret"
+ ]
+ },
+ "notification_setting": {
+ "description": "Whether team members will receive notifications when their team is @mentioned",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "id"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "team",
+ "organization",
+ "sender"
+ ]
+ },
+ "webhook-watch-started": {
+ "title": "watch started event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "started"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender"
+ ]
+ },
+ "webhook-workflow-dispatch": {
+ "title": "workflow_dispatch event",
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "inputs": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "inputs",
+ "ref",
+ "repository",
+ "sender",
+ "workflow"
+ ]
+ },
+ "webhook-workflow-job-completed": {
+ "title": "workflow_job completed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "completed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow_job": {
+ "allOf": [
+ {
+ "title": "Workflow Job",
+ "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.",
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ null,
+ "skipped",
+ "cancelled",
+ "action_required",
+ "neutral",
+ "timed_out"
+ ]
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "number"
+ },
+ "run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "runner_group_id": {
+ "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_name": {
+ "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string"
+ },
+ "status": {
+ "description": "The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`.",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "waiting"
+ ]
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "title": "Workflow Step",
+ "type": "object",
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "failure",
+ "skipped",
+ "success",
+ "cancelled",
+ null
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "started_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "in_progress",
+ "completed",
+ "queued"
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number",
+ "started_at",
+ "completed_at"
+ ]
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "run_id",
+ "run_url",
+ "run_attempt",
+ "node_id",
+ "head_sha",
+ "url",
+ "html_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "name",
+ "steps",
+ "check_run_url",
+ "labels",
+ "runner_id",
+ "runner_name",
+ "runner_group_id",
+ "runner_group_name",
+ "workflow_name",
+ "head_branch",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string"
+ },
+ "completed_at": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "enum": [
+ "success",
+ "failure",
+ "skipped",
+ "cancelled",
+ "action_required",
+ "neutral",
+ "timed_out"
+ ]
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "integer"
+ },
+ "run_url": {
+ "type": "string"
+ },
+ "runner_group_id": {
+ "type": "number",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "type": "number",
+ "nullable": true
+ },
+ "runner_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "conclusion"
+ ]
+ }
+ ]
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow_job"
+ ]
+ },
+ "webhook-workflow-job-in-progress": {
+ "title": "workflow_job in_progress event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "in_progress"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow_job": {
+ "allOf": [
+ {
+ "title": "Workflow Job",
+ "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.",
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ null,
+ "cancelled",
+ "neutral"
+ ]
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "number"
+ },
+ "run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "runner_group_id": {
+ "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_name": {
+ "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string"
+ },
+ "status": {
+ "description": "The current status of the job. Can be `queued`, `in_progress`, or `completed`.",
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "title": "Workflow Step",
+ "type": "object",
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "failure",
+ "skipped",
+ "success",
+ null,
+ "cancelled"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "started_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "in_progress",
+ "completed",
+ "queued",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number",
+ "started_at",
+ "completed_at"
+ ]
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "run_id",
+ "run_url",
+ "run_attempt",
+ "node_id",
+ "head_sha",
+ "url",
+ "html_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "name",
+ "steps",
+ "check_run_url",
+ "labels",
+ "runner_id",
+ "runner_name",
+ "runner_group_id",
+ "runner_group_name",
+ "workflow_name",
+ "head_branch",
+ "created_at"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string"
+ },
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "integer"
+ },
+ "run_url": {
+ "type": "string"
+ },
+ "runner_group_id": {
+ "type": "number",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "type": "number",
+ "nullable": true
+ },
+ "runner_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "in_progress",
+ "completed",
+ "queued"
+ ]
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "title": "Workflow Step",
+ "type": "object",
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "started_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "in_progress",
+ "completed",
+ "pending",
+ "queued"
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number",
+ "started_at",
+ "completed_at"
+ ]
+ }
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "steps"
+ ]
+ }
+ ]
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow_job"
+ ]
+ },
+ "webhook-workflow-job-queued": {
+ "title": "workflow_job queued event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "queued"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow_job": {
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "number"
+ },
+ "run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "runner_group_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "waiting"
+ ]
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "title": "Workflow Step",
+ "type": "object",
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "failure",
+ "skipped",
+ "success",
+ "cancelled",
+ null
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "started_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "in_progress",
+ "queued",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number",
+ "started_at",
+ "completed_at"
+ ]
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "run_id",
+ "run_url",
+ "run_attempt",
+ "node_id",
+ "head_sha",
+ "url",
+ "html_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "name",
+ "steps",
+ "check_run_url",
+ "labels",
+ "runner_id",
+ "runner_name",
+ "runner_group_id",
+ "runner_group_name",
+ "workflow_name",
+ "head_branch",
+ "created_at"
+ ]
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow_job"
+ ]
+ },
+ "webhook-workflow-job-waiting": {
+ "title": "workflow_job waiting event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "waiting"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow_job": {
+ "type": "object",
+ "properties": {
+ "check_run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "description": "The time that the job created.",
+ "type": "string"
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_id": {
+ "type": "number"
+ },
+ "run_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "runner_group_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_group_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "runner_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "runner_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "head_branch": {
+ "type": "string",
+ "description": "The name of the current branch.",
+ "nullable": true
+ },
+ "workflow_name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed",
+ "waiting"
+ ]
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "title": "Workflow Step",
+ "type": "object",
+ "properties": {
+ "completed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "failure",
+ "skipped",
+ "success",
+ "cancelled",
+ null
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ },
+ "started_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "in_progress",
+ "queued",
+ "pending",
+ "waiting"
+ ]
+ }
+ },
+ "required": [
+ "name",
+ "status",
+ "conclusion",
+ "number",
+ "started_at",
+ "completed_at"
+ ]
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "run_id",
+ "run_url",
+ "run_attempt",
+ "node_id",
+ "head_sha",
+ "url",
+ "html_url",
+ "status",
+ "conclusion",
+ "started_at",
+ "completed_at",
+ "name",
+ "steps",
+ "check_run_url",
+ "labels",
+ "runner_id",
+ "runner_name",
+ "runner_group_id",
+ "runner_group_name",
+ "workflow_name",
+ "head_branch",
+ "created_at"
+ ]
+ },
+ "deployment": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow_job"
+ ]
+ },
+ "webhook-workflow-run-completed": {
+ "title": "workflow_run completed event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "completed"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "badge_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "badge_url",
+ "created_at",
+ "html_url",
+ "id",
+ "name",
+ "node_id",
+ "path",
+ "state",
+ "updated_at",
+ "url"
+ ]
+ },
+ "workflow_run": {
+ "allOf": [
+ {
+ "title": "Workflow Run",
+ "type": "object",
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "cancel_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null,
+ "skipped"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "logs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "number"
+ },
+ "number": {
+ "type": "number"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "rerun_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "pending",
+ "waiting"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "artifacts_url",
+ "cancel_url",
+ "check_suite_url",
+ "check_suite_id",
+ "check_suite_node_id",
+ "conclusion",
+ "created_at",
+ "event",
+ "head_branch",
+ "head_commit",
+ "head_repository",
+ "head_sha",
+ "html_url",
+ "id",
+ "jobs_url",
+ "logs_url",
+ "node_id",
+ "name",
+ "path",
+ "pull_requests",
+ "repository",
+ "rerun_url",
+ "run_number",
+ "status",
+ "updated_at",
+ "url",
+ "workflow_id",
+ "workflow_url",
+ "run_attempt",
+ "run_started_at",
+ "previous_attempt_url",
+ "actor",
+ "triggering_actor"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "actor": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ "skipped"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "committer": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ }
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "triggering_actor": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "conclusion"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow",
+ "workflow_run"
+ ]
+ },
+ "webhook-workflow-run-in-progress": {
+ "title": "workflow_run in_progress event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "in_progress"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "badge_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "badge_url",
+ "created_at",
+ "html_url",
+ "id",
+ "name",
+ "node_id",
+ "path",
+ "state",
+ "updated_at",
+ "url"
+ ]
+ },
+ "workflow_run": {
+ "allOf": [
+ {
+ "title": "Workflow Run",
+ "type": "object",
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "cancel_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ "skipped",
+ null
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "logs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "number"
+ },
+ "number": {
+ "type": "number"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "rerun_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "pending"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "artifacts_url",
+ "cancel_url",
+ "check_suite_url",
+ "check_suite_id",
+ "check_suite_node_id",
+ "conclusion",
+ "created_at",
+ "event",
+ "head_branch",
+ "head_commit",
+ "head_repository",
+ "head_sha",
+ "html_url",
+ "id",
+ "jobs_url",
+ "logs_url",
+ "node_id",
+ "name",
+ "path",
+ "pull_requests",
+ "repository",
+ "rerun_url",
+ "run_number",
+ "status",
+ "updated_at",
+ "url",
+ "workflow_id",
+ "workflow_url",
+ "run_attempt",
+ "run_started_at",
+ "previous_attempt_url",
+ "actor",
+ "triggering_actor"
+ ]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "actor": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "artifacts_url": {
+ "type": "string"
+ },
+ "cancel_url": {
+ "type": "string"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "skipped",
+ "stale"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "type": "object",
+ "properties": {
+ "author": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "committer": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ }
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ }
+ },
+ "head_repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string"
+ },
+ "logs_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "nullable": true
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string"
+ },
+ "assignees_url": {
+ "type": "string"
+ },
+ "blobs_url": {
+ "type": "string"
+ },
+ "branches_url": {
+ "type": "string"
+ },
+ "collaborators_url": {
+ "type": "string"
+ },
+ "comments_url": {
+ "type": "string"
+ },
+ "commits_url": {
+ "type": "string"
+ },
+ "compare_url": {
+ "type": "string"
+ },
+ "contents_url": {
+ "type": "string"
+ },
+ "contributors_url": {
+ "type": "string"
+ },
+ "deployments_url": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string"
+ },
+ "git_refs_url": {
+ "type": "string"
+ },
+ "git_tags_url": {
+ "type": "string"
+ },
+ "hooks_url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string"
+ },
+ "issue_events_url": {
+ "type": "string"
+ },
+ "issues_url": {
+ "type": "string"
+ },
+ "keys_url": {
+ "type": "string"
+ },
+ "labels_url": {
+ "type": "string"
+ },
+ "languages_url": {
+ "type": "string"
+ },
+ "merges_url": {
+ "type": "string"
+ },
+ "milestones_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string"
+ },
+ "owner": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string"
+ },
+ "releases_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string"
+ },
+ "statuses_url": {
+ "type": "string"
+ },
+ "subscribers_url": {
+ "type": "string"
+ },
+ "subscription_url": {
+ "type": "string"
+ },
+ "tags_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "trees_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "rerun_url": {
+ "type": "string"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "triggering_actor": {
+ "type": "object",
+ "properties": {
+ "avatar_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "conclusion"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow",
+ "workflow_run"
+ ]
+ },
+ "webhook-workflow-run-requested": {
+ "title": "workflow_run requested event",
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string",
+ "enum": [
+ "requested"
+ ]
+ },
+ "enterprise": {
+ "$ref": "#/components/schemas/enterprise-webhooks"
+ },
+ "installation": {
+ "$ref": "#/components/schemas/simple-installation"
+ },
+ "organization": {
+ "$ref": "#/components/schemas/organization-simple-webhooks"
+ },
+ "repository": {
+ "$ref": "#/components/schemas/repository-webhooks"
+ },
+ "sender": {
+ "$ref": "#/components/schemas/simple-user-webhooks"
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "badge_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "badge_url",
+ "created_at",
+ "html_url",
+ "id",
+ "name",
+ "node_id",
+ "path",
+ "state",
+ "updated_at",
+ "url"
+ ]
+ },
+ "workflow_run": {
+ "title": "Workflow Run",
+ "type": "object",
+ "properties": {
+ "actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "artifacts_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "cancel_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "check_suite_id": {
+ "type": "integer"
+ },
+ "check_suite_node_id": {
+ "type": "string"
+ },
+ "check_suite_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "conclusion": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "timed_out",
+ "action_required",
+ "stale",
+ null,
+ "skipped",
+ "startup_failure"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "event": {
+ "type": "string"
+ },
+ "head_branch": {
+ "type": "string",
+ "nullable": true
+ },
+ "head_commit": {
+ "title": "SimpleCommit",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "Metaproperties for Git author/committer information.",
+ "type": "object",
+ "properties": {
+ "date": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true,
+ "format": "email"
+ },
+ "name": {
+ "description": "The git author's name.",
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "name"
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "tree_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "tree_id",
+ "message",
+ "timestamp",
+ "author",
+ "committer"
+ ]
+ },
+ "head_repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "head_sha": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "jobs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "logs_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "previous_attempt_url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri"
+ },
+ "pull_requests": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "title": "Repo Ref",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "name"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "ref",
+ "sha",
+ "repo"
+ ]
+ },
+ "id": {
+ "type": "number"
+ },
+ "number": {
+ "type": "number"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "url",
+ "id",
+ "number",
+ "head",
+ "base"
+ ]
+ }
+ },
+ "referenced_workflows": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "path",
+ "sha"
+ ]
+ }
+ },
+ "repository": {
+ "title": "Repository Lite",
+ "type": "object",
+ "properties": {
+ "archive_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "assignees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "blobs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "branches_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "compare_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contents_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "description": "Unique identifier of the repository",
+ "type": "integer"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "labels_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "milestones_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "owner": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "type": "boolean"
+ },
+ "pulls_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "releases_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "trees_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "node_id",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
+ ]
+ },
+ "rerun_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "run_attempt": {
+ "type": "integer"
+ },
+ "run_number": {
+ "type": "integer"
+ },
+ "run_started_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "requested",
+ "in_progress",
+ "completed",
+ "queued",
+ "pending",
+ "waiting"
+ ]
+ },
+ "triggering_actor": {
+ "title": "User",
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "login": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri-template"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "Bot",
+ "User",
+ "Organization"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "login",
+ "id"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "workflow_id": {
+ "type": "integer"
+ },
+ "workflow_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "display_title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "artifacts_url",
+ "cancel_url",
+ "check_suite_url",
+ "check_suite_id",
+ "check_suite_node_id",
+ "conclusion",
+ "created_at",
+ "event",
+ "head_branch",
+ "head_commit",
+ "head_repository",
+ "head_sha",
+ "html_url",
+ "id",
+ "jobs_url",
+ "logs_url",
+ "node_id",
+ "name",
+ "path",
+ "pull_requests",
+ "repository",
+ "rerun_url",
+ "run_number",
+ "status",
+ "updated_at",
+ "url",
+ "workflow_id",
+ "workflow_url",
+ "run_attempt",
+ "run_started_at",
+ "previous_attempt_url",
+ "actor",
+ "triggering_actor",
+ "display_title"
+ ]
+ }
+ },
+ "required": [
+ "action",
+ "repository",
+ "sender",
+ "workflow",
+ "workflow_run"
+ ]
+ }
+ },
+ "examples": {
+ "root": {
+ "value": {
+ "current_user_url": "https://api.github.com/user",
+ "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
+ "authorizations_url": "https://api.github.com/authorizations",
+ "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
+ "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}",
+ "emails_url": "https://api.github.com/user/emails",
+ "emojis_url": "https://api.github.com/emojis",
+ "events_url": "https://api.github.com/events",
+ "feeds_url": "https://api.github.com/feeds",
+ "followers_url": "https://api.github.com/user/followers",
+ "following_url": "https://api.github.com/user/following{/target}",
+ "gists_url": "https://api.github.com/gists{/gist_id}",
+ "hub_url": "https://api.github.com/hub",
+ "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",
+ "issues_url": "https://api.github.com/issues",
+ "keys_url": "https://api.github.com/user/keys",
+ "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}",
+ "notifications_url": "https://api.github.com/notifications",
+ "organization_url": "https://api.github.com/orgs/{org}",
+ "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}",
+ "organization_teams_url": "https://api.github.com/orgs/{org}/teams",
+ "public_gists_url": "https://api.github.com/gists/public",
+ "rate_limit_url": "https://api.github.com/rate_limit",
+ "repository_url": "https://api.github.com/repos/{owner}/{repo}",
+ "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",
+ "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}",
+ "starred_url": "https://api.github.com/user/starred{/owner}{/repo}",
+ "starred_gists_url": "https://api.github.com/gists/starred",
+ "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}",
+ "user_url": "https://api.github.com/users/{user}",
+ "user_organizations_url": "https://api.github.com/user/orgs",
+ "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",
+ "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"
+ }
+ },
+ "global-advisory-items": {
+ "value": [
+ {
+ "id": 1,
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh",
+ "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "summary": "Heartbleed security advisory",
+ "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.",
+ "type": "reviewed",
+ "severity": "high",
+ "source_code_location": "https://github.com/project/a-package",
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "references": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000"
+ ],
+ "published_at": "2023-03-23T02:30:56Z",
+ "updated_at": "2023-03-24T02:30:56Z",
+ "github_reviewed_at": "2023-03-23T02:30:56Z",
+ "nvd_published_at": "2023-03-25T02:30:56Z",
+ "withdrawn_at": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "npm",
+ "name": "a-package"
+ },
+ "first_patched_version": "1.0.3",
+ "vulnerable_version_range": "<=1.0.2",
+ "vulnerable_functions": [
+ "a_function"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H",
+ "score": 7.6
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-400",
+ "name": "Uncontrolled Resource Consumption"
+ }
+ ],
+ "credits": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst"
+ }
+ ]
+ }
+ ]
+ },
+ "global-advisory": {
+ "value": {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh",
+ "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "type": "reviewed",
+ "severity": "high",
+ "source_code_location": "https://github.com/project/a-package",
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "references": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000"
+ ],
+ "published_at": "2023-03-23T02:30:56Z",
+ "updated_at": "2023-03-24T02:30:56Z",
+ "github_reviewed_at": "2023-03-23T02:30:56Z",
+ "nvd_published_at": "2023-03-25T02:30:56Z",
+ "withdrawn_at": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "npm",
+ "name": "a-package"
+ },
+ "first_patched_version": "1.0.3",
+ "vulnerable_version_range": "<=1.0.2",
+ "vulnerable_functions": [
+ "a_function"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H",
+ "score": 7.6
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-400",
+ "name": "Uncontrolled Resource Consumption"
+ }
+ ],
+ "credits": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst"
+ }
+ ]
+ }
+ },
+ "integration": {
+ "value": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ },
+ "integration-from-manifest": {
+ "value": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDxOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "client_id": "Iv1.8a61f9b3a7aba766",
+ "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
+ "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
+ "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
+ }
+ },
+ "webhook-config": {
+ "value": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********",
+ "url": "https://example.com/webhook"
+ }
+ },
+ "hook-delivery-items": {
+ "value": [
+ {
+ "id": 12345678,
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "delivered_at": "2019-06-03T00:57:16Z",
+ "redelivery": false,
+ "duration": 0.27,
+ "status": "OK",
+ "status_code": 200,
+ "event": "issues",
+ "action": "opened",
+ "installation_id": 123,
+ "repository_id": 456
+ },
+ {
+ "id": 123456789,
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "delivered_at": "2019-06-04T00:57:16Z",
+ "redelivery": true,
+ "duration": 0.28,
+ "status": "OK",
+ "status_code": 200,
+ "event": "issues",
+ "action": "opened",
+ "installation_id": 123,
+ "repository_id": 456
+ }
+ ]
+ },
+ "hook-delivery": {
+ "value": {
+ "id": 12345678,
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "delivered_at": "2019-06-03T00:57:16Z",
+ "redelivery": false,
+ "duration": 0.27,
+ "status": "OK",
+ "status_code": 200,
+ "event": "issues",
+ "action": "opened",
+ "installation_id": 123,
+ "repository_id": 456,
+ "url": "https://www.example.com",
+ "request": {
+ "headers": {
+ "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "Accept": "*/*",
+ "X-GitHub-Hook-ID": "42",
+ "User-Agent": "GitHub-Hookshot/b8c71d8",
+ "X-GitHub-Event": "issues",
+ "X-GitHub-Hook-Installation-Target-ID": "123",
+ "X-GitHub-Hook-Installation-Target-Type": "repository",
+ "content-type": "application/json",
+ "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
+ },
+ "payload": {
+ "action": "opened",
+ "issue": {
+ "body": "foo"
+ },
+ "repository": {
+ "id": 123
+ }
+ }
+ },
+ "response": {
+ "headers": {
+ "Content-Type": "text/html;charset=utf-8"
+ },
+ "payload": "ok"
+ }
+ }
+ },
+ "integration-installation-request-paginated": {
+ "value": [
+ {
+ "id": 25381,
+ "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==",
+ "account": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "requester": {
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2022-07-08T16:18:44-04:00"
+ }
+ ]
+ },
+ "base-installation-items": {
+ "value": [
+ {
+ "id": 1,
+ "account": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "single_file_name": "config.yaml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "repository_selection": "selected",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ }
+ ]
+ },
+ "base-installation": {
+ "value": {
+ "id": 1,
+ "account": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "single_file_name": "config.yaml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "repository_selection": "selected",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ }
+ },
+ "installation-token": {
+ "value": {
+ "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a",
+ "expires_at": "2016-07-11T22:14:10Z",
+ "permissions": {
+ "issues": "write",
+ "contents": "read"
+ },
+ "repository_selection": "selected",
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ]
+ }
+ },
+ "authorization-with-user": {
+ "value": {
+ "id": 1,
+ "url": "https://api.github.com/authorizations/1",
+ "scopes": [
+ "public_repo",
+ "user"
+ ],
+ "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
+ "token_last_eight": "Ae178B4a",
+ "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
+ "app": {
+ "url": "http://my-github-app.com",
+ "name": "my github app",
+ "client_id": "Iv1.8a61f9b3a7aba766"
+ },
+ "note": "optional note",
+ "note_url": "http://optional/note/url",
+ "updated_at": "2011-09-06T20:39:23Z",
+ "created_at": "2011-09-06T17:26:27Z",
+ "fingerprint": "jklmnop12345678",
+ "expires_at": "2011-09-08T17:26:27Z",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "scope-token": {
+ "value": {
+ "id": 1,
+ "url": "https://api.github.com/authorizations/1",
+ "scopes": [
+
+ ],
+ "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
+ "token_last_eight": "Ae178B4a",
+ "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
+ "app": {
+ "url": "http://my-github-app.com",
+ "name": "my github app",
+ "client_id": "Iv1.8a61f9b3a7aba766"
+ },
+ "note": "optional note",
+ "note_url": "http://optional/note/url",
+ "updated_at": "2011-09-06T20:39:23Z",
+ "created_at": "2011-09-06T17:26:27Z",
+ "fingerprint": "jklmnop12345678",
+ "expires_at": "2011-09-08T17:26:27Z",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "installation": {
+ "permissions": {
+ "metadata": "read",
+ "issues": "write",
+ "contents": "read"
+ },
+ "repository_selection": "selected",
+ "single_file_name": ".github/workflow.yml",
+ "repositories_url": "https://api.github.com/user/repos",
+ "account": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "has_multiple_single_files": false,
+ "single_file_paths": [
+
+ ]
+ }
+ }
+ },
+ "classroom-assignment": {
+ "value": {
+ "id": "12,",
+ "public_repo": "false,",
+ "title": "Intro to Binaries",
+ "type": "individual",
+ "invite_link": "https://classroom.github.com/a/Lx7jiUgx",
+ "invitations_enabled": "true,",
+ "slug": "intro-to-binaries",
+ "students_are_repo_admins": false,
+ "feedback_pull_requests_enabled": true,
+ "max_teams": 0,
+ "max_members": 0,
+ "editor": "codespaces",
+ "accepted": 100,
+ "submitted": 40,
+ "passing": 10,
+ "language": "ruby",
+ "deadline": "2011-01-26T19:06:43Z",
+ "stater_code_repository": {
+ "id": 1296269,
+ "full_name": "octocat/Hello-World",
+ "html_url": "https://github.com/octocat/Hello-World",
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "private": false,
+ "default_branch": "main"
+ },
+ "classroom": {
+ "id": 1296269,
+ "name": "Programming Elixir",
+ "archived": "false,",
+ "url": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ }
+ },
+ "classroom-accepted-assignment": {
+ "value": {
+ "id": "12,",
+ "submitted": "false,",
+ "passing": "false,",
+ "commit_count": 5,
+ "grade": "5/10",
+ "students": [
+ {
+ "id": 1,
+ "login": "octocat",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "html_url": "https://github.com/octocat"
+ }
+ ],
+ "repository": {
+ "id": 1296269,
+ "full_name": "octocat/Hello-World",
+ "html_url": "https://github.com/octocat/Hello-World",
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "private": false,
+ "default_branch": "main"
+ },
+ "assignment": {
+ "id": "12,",
+ "public_repo": "false,",
+ "title": "Intro to Binaries",
+ "type": "individual",
+ "invite_link": "https://classroom.github.com/a/Lx7jiUgx",
+ "invitations_enabled": "true,",
+ "slug": "intro-to-binaries",
+ "students_are_repo_admins": false,
+ "feedback_pull_requests_enabled": true,
+ "max_teams": 0,
+ "max_members": 0,
+ "editor": "codespaces",
+ "accepted": 100,
+ "submitted": 40,
+ "passing": 10,
+ "language": "ruby",
+ "classroom": {
+ "id": 1296269,
+ "name": "Programming Elixir",
+ "archived": "false,",
+ "url": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ }
+ }
+ },
+ "classroom-assignment-grades": {
+ "value": [
+ {
+ "assignment_name": "Introduction to Strings",
+ "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337",
+ "starter_code_url": "",
+ "github_username": "octocat",
+ "roster_identifier": "octocat@github.com",
+ "student_repository_name": "intro-to-strings-1337-octocat",
+ "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-octocat",
+ "submission_timestamp": "2018-11-12 01:02",
+ "points_awarded": 10,
+ "points_available": 15,
+ "group_name": "octocat-and-friends"
+ },
+ {
+ "assignment_name": "Introduction to Strings",
+ "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337",
+ "starter_code_url": "",
+ "github_username": "monalisa",
+ "roster_identifier": "monalisa@github.com",
+ "student_repository_name": "intro-to-strings-1337-monalisa",
+ "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-monalisa",
+ "submission_timestamp": "2018-11-12 01:11",
+ "points_awarded": 15,
+ "points_available": 15,
+ "group_name": "monalisa-and-friends"
+ }
+ ]
+ },
+ "simple-classroom": {
+ "value": {
+ "id": 1296269,
+ "name": "Programming Elixir",
+ "archived": "false,",
+ "url": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ },
+ "classroom": {
+ "value": {
+ "id": 1296269,
+ "name": "Programming Elixir",
+ "archived": "false,",
+ "organization": {
+ "id": 1,
+ "login": "programming-elixir",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "html_url": "https://github.com/programming-elixir",
+ "name": "Learn how to build fault tolerant applications",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4"
+ },
+ "url": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ },
+ "simple-classroom-assignment": {
+ "value": {
+ "id": "12,",
+ "public_repo": "false,",
+ "title": "Intro to Binaries",
+ "type": "individual",
+ "invite_link": "https://classroom.github.com/a/Lx7jiUgx",
+ "invitations_enabled": "true,",
+ "slug": "intro-to-binaries",
+ "students_are_repo_admins": false,
+ "feedback_pull_requests_enabled": true,
+ "max_teams": 0,
+ "max_members": 0,
+ "editor": "codespaces",
+ "accepted": 100,
+ "submitted": 40,
+ "passing": 10,
+ "language": "ruby",
+ "deadline": "2020-01-11T11:59:22Z",
+ "classroom": {
+ "id": 1296269,
+ "name": "Programming Elixir",
+ "archived": "false,",
+ "url": "https://classroom.github.com/classrooms/1-programming-elixir"
+ }
+ }
+ },
+ "code-of-conduct-simple-items": {
+ "value": [
+ {
+ "key": "citizen_code_of_conduct",
+ "name": "Citizen Code of Conduct",
+ "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct",
+ "html_url": "http://citizencodeofconduct.org/"
+ },
+ {
+ "key": "contributor_covenant",
+ "name": "Contributor Covenant",
+ "url": "https://api.github.com/codes_of_conduct/contributor_covenant",
+ "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/"
+ }
+ ]
+ },
+ "code-of-conduct": {
+ "value": {
+ "key": "contributor_covenant",
+ "name": "Contributor Covenant",
+ "url": "https://api.github.com/codes_of_conduct/contributor_covenant",
+ "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n",
+ "html_url": "http://contributor-covenant.org/version/1/4/"
+ }
+ },
+ "emojis-get": {
+ "value": {
+ "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8",
+ "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8",
+ "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8",
+ "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8",
+ "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8",
+ "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8",
+ "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8",
+ "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8",
+ "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8",
+ "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8",
+ "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8",
+ "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8",
+ "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8",
+ "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8",
+ "accessibility": "https://github.githubassets.com/images/icons/emoji/accessibility.png?v8",
+ "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8",
+ "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8",
+ "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8",
+ "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8",
+ "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8",
+ "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8",
+ "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8",
+ "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8",
+ "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8",
+ "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8",
+ "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8",
+ "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8",
+ "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8",
+ "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8",
+ "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8",
+ "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8",
+ "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8",
+ "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8",
+ "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8",
+ "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8",
+ "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8",
+ "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8",
+ "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8",
+ "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8",
+ "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8",
+ "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8",
+ "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8",
+ "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8",
+ "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8",
+ "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8",
+ "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8",
+ "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8",
+ "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8",
+ "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8",
+ "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8",
+ "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8",
+ "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8",
+ "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8",
+ "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8",
+ "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8",
+ "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8",
+ "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8",
+ "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8",
+ "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8",
+ "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8",
+ "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8",
+ "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8",
+ "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8",
+ "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8",
+ "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8",
+ "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8",
+ "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8",
+ "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8",
+ "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8",
+ "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8",
+ "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8",
+ "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8",
+ "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8",
+ "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8",
+ "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8",
+ "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8",
+ "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8",
+ "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8",
+ "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8",
+ "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8",
+ "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8",
+ "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8",
+ "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8",
+ "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8",
+ "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8",
+ "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8",
+ "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8",
+ "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8",
+ "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8",
+ "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8",
+ "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8",
+ "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8",
+ "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8",
+ "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8",
+ "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8",
+ "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8",
+ "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8",
+ "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8",
+ "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8",
+ "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8",
+ "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8",
+ "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8",
+ "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8",
+ "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8",
+ "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8",
+ "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8",
+ "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8",
+ "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8",
+ "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8",
+ "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8",
+ "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8",
+ "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8",
+ "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8",
+ "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8",
+ "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8",
+ "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8",
+ "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8",
+ "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8",
+ "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8",
+ "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8",
+ "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8",
+ "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8",
+ "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8",
+ "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8",
+ "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8",
+ "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8",
+ "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8",
+ "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8",
+ "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8",
+ "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8",
+ "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8",
+ "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8",
+ "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8",
+ "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8",
+ "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8",
+ "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8",
+ "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8",
+ "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8",
+ "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8",
+ "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8",
+ "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8",
+ "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8",
+ "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8",
+ "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8",
+ "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8",
+ "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8",
+ "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8",
+ "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8",
+ "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8",
+ "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8",
+ "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8",
+ "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8",
+ "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8",
+ "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8",
+ "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8",
+ "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8",
+ "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8",
+ "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8",
+ "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8",
+ "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8",
+ "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8",
+ "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8",
+ "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8",
+ "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8",
+ "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8",
+ "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8",
+ "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8",
+ "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8",
+ "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8",
+ "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8",
+ "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8",
+ "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8",
+ "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8",
+ "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8",
+ "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8",
+ "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8",
+ "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8",
+ "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8",
+ "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8",
+ "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8",
+ "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8",
+ "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8",
+ "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8",
+ "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8",
+ "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8",
+ "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8",
+ "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8",
+ "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8",
+ "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8",
+ "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8",
+ "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8",
+ "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8",
+ "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8",
+ "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8",
+ "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8",
+ "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8",
+ "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8",
+ "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8",
+ "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8",
+ "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8",
+ "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8",
+ "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8",
+ "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8",
+ "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8",
+ "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8",
+ "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8",
+ "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8",
+ "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8",
+ "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8",
+ "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8",
+ "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8",
+ "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8",
+ "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8",
+ "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8",
+ "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8",
+ "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8",
+ "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8",
+ "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8",
+ "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8",
+ "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8",
+ "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8",
+ "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8",
+ "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8",
+ "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8",
+ "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8",
+ "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8",
+ "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8",
+ "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8",
+ "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8",
+ "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8",
+ "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8",
+ "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8",
+ "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8",
+ "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8",
+ "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8",
+ "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8",
+ "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8",
+ "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8",
+ "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8",
+ "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8",
+ "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8",
+ "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8",
+ "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8",
+ "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8",
+ "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8",
+ "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8",
+ "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8",
+ "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8",
+ "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8",
+ "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8",
+ "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8",
+ "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8",
+ "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8",
+ "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8",
+ "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8",
+ "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8",
+ "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8",
+ "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8",
+ "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8",
+ "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8",
+ "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8",
+ "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8",
+ "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8",
+ "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8",
+ "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8",
+ "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8",
+ "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8",
+ "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8",
+ "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8",
+ "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8",
+ "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8",
+ "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8",
+ "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8",
+ "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8",
+ "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8",
+ "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8",
+ "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8",
+ "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8",
+ "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8",
+ "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8",
+ "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8",
+ "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8",
+ "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8",
+ "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8",
+ "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8",
+ "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8",
+ "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8",
+ "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8",
+ "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8",
+ "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8",
+ "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8",
+ "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8",
+ "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8",
+ "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8",
+ "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8",
+ "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8",
+ "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8",
+ "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8",
+ "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8",
+ "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8",
+ "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8",
+ "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8",
+ "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8",
+ "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8",
+ "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8",
+ "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8",
+ "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8",
+ "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8",
+ "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8",
+ "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8",
+ "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8",
+ "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8",
+ "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8",
+ "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8",
+ "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8",
+ "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8",
+ "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8",
+ "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8",
+ "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8",
+ "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8",
+ "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8",
+ "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8",
+ "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8",
+ "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8",
+ "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8",
+ "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8",
+ "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8",
+ "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8",
+ "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8",
+ "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8",
+ "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8",
+ "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8",
+ "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8",
+ "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8",
+ "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8",
+ "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8",
+ "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8",
+ "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8",
+ "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8",
+ "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8",
+ "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8",
+ "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8",
+ "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8",
+ "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8",
+ "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8",
+ "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8",
+ "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8",
+ "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8",
+ "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8",
+ "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8",
+ "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8",
+ "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8",
+ "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8",
+ "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8",
+ "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8",
+ "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8",
+ "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8",
+ "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8",
+ "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8",
+ "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8",
+ "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8",
+ "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8",
+ "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8",
+ "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8",
+ "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8",
+ "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8",
+ "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8",
+ "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8",
+ "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8",
+ "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8",
+ "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8",
+ "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8",
+ "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8",
+ "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8",
+ "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8",
+ "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8",
+ "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8",
+ "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8",
+ "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8",
+ "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8",
+ "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8",
+ "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8",
+ "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8",
+ "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8",
+ "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8",
+ "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8",
+ "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8",
+ "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8",
+ "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8",
+ "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8",
+ "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8",
+ "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8",
+ "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8",
+ "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8",
+ "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8",
+ "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8",
+ "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8",
+ "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8",
+ "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8",
+ "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8",
+ "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8",
+ "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8",
+ "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8",
+ "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8",
+ "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8",
+ "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8",
+ "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8",
+ "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8",
+ "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8",
+ "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8",
+ "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8",
+ "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8",
+ "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8",
+ "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8",
+ "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8",
+ "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8",
+ "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8",
+ "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8",
+ "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8",
+ "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8",
+ "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8",
+ "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8",
+ "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8",
+ "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8",
+ "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8",
+ "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8",
+ "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8",
+ "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8",
+ "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8",
+ "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8",
+ "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8",
+ "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8",
+ "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8",
+ "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8",
+ "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8",
+ "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8",
+ "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8",
+ "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8",
+ "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8",
+ "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8",
+ "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8",
+ "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8",
+ "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8",
+ "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8",
+ "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8",
+ "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8",
+ "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8",
+ "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8",
+ "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8",
+ "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8",
+ "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8",
+ "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8",
+ "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8",
+ "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8",
+ "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8",
+ "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8",
+ "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8",
+ "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8",
+ "dependabot": "https://github.githubassets.com/images/icons/emoji/dependabot.png?v8",
+ "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8",
+ "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8",
+ "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8",
+ "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8",
+ "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8",
+ "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8",
+ "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8",
+ "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8",
+ "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8",
+ "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8",
+ "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8",
+ "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8",
+ "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8",
+ "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8",
+ "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8",
+ "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8",
+ "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8",
+ "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8",
+ "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8",
+ "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8",
+ "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8",
+ "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8",
+ "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8",
+ "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8",
+ "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8",
+ "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8",
+ "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8",
+ "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8",
+ "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8",
+ "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8",
+ "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8",
+ "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8",
+ "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8",
+ "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8",
+ "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8",
+ "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8",
+ "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8",
+ "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8",
+ "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8",
+ "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8",
+ "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8",
+ "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8",
+ "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8",
+ "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8",
+ "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8",
+ "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8",
+ "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8",
+ "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8",
+ "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8",
+ "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8",
+ "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8",
+ "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8",
+ "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8",
+ "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8",
+ "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8",
+ "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8",
+ "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8",
+ "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8",
+ "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8",
+ "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8",
+ "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8",
+ "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8",
+ "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8",
+ "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8",
+ "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8",
+ "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8",
+ "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8",
+ "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8",
+ "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8",
+ "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8",
+ "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8",
+ "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8",
+ "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8",
+ "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8",
+ "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8",
+ "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8",
+ "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8",
+ "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8",
+ "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8",
+ "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8",
+ "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8",
+ "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8",
+ "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8",
+ "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8",
+ "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8",
+ "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8",
+ "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8",
+ "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8",
+ "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8",
+ "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8",
+ "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8",
+ "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8",
+ "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8",
+ "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8",
+ "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8",
+ "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8",
+ "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8",
+ "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8",
+ "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8",
+ "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8",
+ "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8",
+ "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8",
+ "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8",
+ "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8",
+ "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8",
+ "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8",
+ "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8",
+ "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8",
+ "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8",
+ "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8",
+ "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8",
+ "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8",
+ "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8",
+ "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8",
+ "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8",
+ "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8",
+ "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8",
+ "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8",
+ "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8",
+ "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8",
+ "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8",
+ "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8",
+ "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8",
+ "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8",
+ "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8",
+ "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8",
+ "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8",
+ "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8",
+ "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8",
+ "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8",
+ "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8",
+ "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8",
+ "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8",
+ "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8",
+ "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8",
+ "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8",
+ "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8",
+ "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8",
+ "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8",
+ "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8",
+ "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8",
+ "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8",
+ "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8",
+ "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8",
+ "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8",
+ "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8",
+ "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8",
+ "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8",
+ "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8",
+ "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8",
+ "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8",
+ "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8",
+ "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8",
+ "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8",
+ "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8",
+ "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8",
+ "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8",
+ "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8",
+ "fishsticks": "https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8",
+ "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8",
+ "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8",
+ "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8",
+ "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8",
+ "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8",
+ "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8",
+ "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8",
+ "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8",
+ "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8",
+ "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8",
+ "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8",
+ "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8",
+ "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8",
+ "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8",
+ "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8",
+ "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8",
+ "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8",
+ "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8",
+ "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8",
+ "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8",
+ "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8",
+ "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8",
+ "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8",
+ "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8",
+ "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8",
+ "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8",
+ "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8",
+ "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8",
+ "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8",
+ "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8",
+ "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8",
+ "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8",
+ "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8",
+ "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8",
+ "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8",
+ "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8",
+ "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8",
+ "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8",
+ "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8",
+ "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8",
+ "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8",
+ "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8",
+ "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8",
+ "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8",
+ "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8",
+ "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8",
+ "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8",
+ "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8",
+ "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8",
+ "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8",
+ "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8",
+ "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8",
+ "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8",
+ "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8",
+ "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8",
+ "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8",
+ "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8",
+ "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8",
+ "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8",
+ "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8",
+ "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8",
+ "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8",
+ "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8",
+ "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8",
+ "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8",
+ "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8",
+ "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8",
+ "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8",
+ "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8",
+ "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8",
+ "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8",
+ "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8",
+ "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8",
+ "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8",
+ "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8",
+ "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8",
+ "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8",
+ "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8",
+ "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8",
+ "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8",
+ "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8",
+ "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8",
+ "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8",
+ "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8",
+ "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8",
+ "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8",
+ "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8",
+ "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8",
+ "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8",
+ "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8",
+ "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8",
+ "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8",
+ "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8",
+ "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8",
+ "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8",
+ "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8",
+ "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8",
+ "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8",
+ "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8",
+ "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8",
+ "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8",
+ "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8",
+ "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8",
+ "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8",
+ "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8",
+ "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8",
+ "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8",
+ "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8",
+ "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8",
+ "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8",
+ "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8",
+ "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8",
+ "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8",
+ "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8",
+ "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8",
+ "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8",
+ "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8",
+ "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8",
+ "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8",
+ "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8",
+ "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8",
+ "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8",
+ "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8",
+ "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8",
+ "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8",
+ "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8",
+ "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8",
+ "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8",
+ "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8",
+ "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8",
+ "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8",
+ "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8",
+ "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8",
+ "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8",
+ "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8",
+ "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8",
+ "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8",
+ "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8",
+ "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8",
+ "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8",
+ "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8",
+ "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8",
+ "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8",
+ "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8",
+ "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8",
+ "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8",
+ "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8",
+ "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8",
+ "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8",
+ "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8",
+ "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8",
+ "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8",
+ "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8",
+ "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8",
+ "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8",
+ "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8",
+ "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8",
+ "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8",
+ "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8",
+ "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8",
+ "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8",
+ "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8",
+ "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8",
+ "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8",
+ "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8",
+ "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8",
+ "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8",
+ "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8",
+ "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8",
+ "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8",
+ "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8",
+ "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8",
+ "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8",
+ "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8",
+ "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8",
+ "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8",
+ "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8",
+ "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8",
+ "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8",
+ "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8",
+ "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8",
+ "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8",
+ "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8",
+ "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8",
+ "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8",
+ "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8",
+ "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8",
+ "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8",
+ "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8",
+ "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8",
+ "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8",
+ "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8",
+ "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8",
+ "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8",
+ "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8",
+ "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8",
+ "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8",
+ "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8",
+ "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8",
+ "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8",
+ "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8",
+ "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8",
+ "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8",
+ "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8",
+ "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8",
+ "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8",
+ "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8",
+ "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8",
+ "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8",
+ "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8",
+ "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8",
+ "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8",
+ "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8",
+ "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8",
+ "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8",
+ "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8",
+ "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8",
+ "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8",
+ "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8",
+ "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8",
+ "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8",
+ "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8",
+ "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8",
+ "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8",
+ "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8",
+ "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8",
+ "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8",
+ "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8",
+ "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8",
+ "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8",
+ "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8",
+ "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8",
+ "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8",
+ "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8",
+ "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8",
+ "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8",
+ "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8",
+ "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8",
+ "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8",
+ "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8",
+ "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8",
+ "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8",
+ "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8",
+ "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8",
+ "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8",
+ "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8",
+ "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8",
+ "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8",
+ "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8",
+ "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8",
+ "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8",
+ "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8",
+ "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8",
+ "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8",
+ "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8",
+ "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8",
+ "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8",
+ "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8",
+ "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8",
+ "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8",
+ "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8",
+ "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8",
+ "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8",
+ "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8",
+ "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8",
+ "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8",
+ "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8",
+ "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8",
+ "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8",
+ "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8",
+ "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8",
+ "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8",
+ "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8",
+ "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8",
+ "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8",
+ "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8",
+ "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8",
+ "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8",
+ "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8",
+ "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8",
+ "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8",
+ "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8",
+ "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8",
+ "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8",
+ "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8",
+ "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8",
+ "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8",
+ "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8",
+ "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8",
+ "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8",
+ "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8",
+ "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8",
+ "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8",
+ "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8",
+ "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8",
+ "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8",
+ "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8",
+ "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8",
+ "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8",
+ "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8",
+ "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8",
+ "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8",
+ "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8",
+ "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8",
+ "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8",
+ "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8",
+ "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8",
+ "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8",
+ "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8",
+ "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8",
+ "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8",
+ "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8",
+ "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8",
+ "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8",
+ "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8",
+ "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8",
+ "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8",
+ "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8",
+ "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8",
+ "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8",
+ "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8",
+ "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8",
+ "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8",
+ "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8",
+ "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8",
+ "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8",
+ "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8",
+ "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8",
+ "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8",
+ "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8",
+ "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8",
+ "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8",
+ "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8",
+ "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8",
+ "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8",
+ "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8",
+ "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8",
+ "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8",
+ "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8",
+ "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8",
+ "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8",
+ "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8",
+ "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8",
+ "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8",
+ "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8",
+ "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8",
+ "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8",
+ "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8",
+ "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8",
+ "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8",
+ "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8",
+ "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8",
+ "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8",
+ "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8",
+ "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8",
+ "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8",
+ "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8",
+ "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8",
+ "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8",
+ "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8",
+ "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8",
+ "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8",
+ "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8",
+ "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8",
+ "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8",
+ "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8",
+ "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8",
+ "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8",
+ "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8",
+ "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8",
+ "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8",
+ "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8",
+ "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8",
+ "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8",
+ "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8",
+ "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8",
+ "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8",
+ "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8",
+ "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8",
+ "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8",
+ "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8",
+ "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8",
+ "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8",
+ "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8",
+ "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8",
+ "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8",
+ "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8",
+ "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8",
+ "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8",
+ "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8",
+ "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8",
+ "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8",
+ "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8",
+ "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8",
+ "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8",
+ "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8",
+ "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8",
+ "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8",
+ "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8",
+ "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8",
+ "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8",
+ "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8",
+ "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8",
+ "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8",
+ "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8",
+ "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8",
+ "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8",
+ "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8",
+ "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8",
+ "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8",
+ "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8",
+ "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8",
+ "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8",
+ "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8",
+ "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8",
+ "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8",
+ "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8",
+ "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8",
+ "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8",
+ "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8",
+ "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8",
+ "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8",
+ "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8",
+ "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8",
+ "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8",
+ "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8",
+ "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8",
+ "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8",
+ "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8",
+ "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8",
+ "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8",
+ "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8",
+ "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8",
+ "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8",
+ "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8",
+ "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8",
+ "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8",
+ "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8",
+ "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8",
+ "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8",
+ "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8",
+ "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8",
+ "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8",
+ "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8",
+ "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8",
+ "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8",
+ "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8",
+ "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8",
+ "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8",
+ "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8",
+ "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8",
+ "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8",
+ "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8",
+ "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8",
+ "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8",
+ "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8",
+ "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8",
+ "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8",
+ "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8",
+ "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8",
+ "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8",
+ "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8",
+ "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8",
+ "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8",
+ "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8",
+ "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8",
+ "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8",
+ "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8",
+ "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8",
+ "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8",
+ "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8",
+ "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8",
+ "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8",
+ "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8",
+ "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8",
+ "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8",
+ "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8",
+ "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8",
+ "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8",
+ "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8",
+ "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8",
+ "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8",
+ "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8",
+ "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8",
+ "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8",
+ "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8",
+ "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8",
+ "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8",
+ "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8",
+ "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8",
+ "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8",
+ "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8",
+ "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8",
+ "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8",
+ "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8",
+ "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8",
+ "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8",
+ "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8",
+ "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8",
+ "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8",
+ "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8",
+ "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8",
+ "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8",
+ "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8",
+ "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8",
+ "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8",
+ "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8",
+ "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8",
+ "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8",
+ "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8",
+ "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8",
+ "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8",
+ "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8",
+ "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8",
+ "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8",
+ "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8",
+ "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8",
+ "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8",
+ "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8",
+ "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8",
+ "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8",
+ "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8",
+ "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8",
+ "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8",
+ "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8",
+ "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8",
+ "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8",
+ "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8",
+ "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8",
+ "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8",
+ "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8",
+ "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8",
+ "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8",
+ "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8",
+ "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8",
+ "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8",
+ "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8",
+ "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8",
+ "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8",
+ "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8",
+ "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8",
+ "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8",
+ "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8",
+ "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8",
+ "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8",
+ "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8",
+ "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8",
+ "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8",
+ "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8",
+ "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8",
+ "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8",
+ "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8",
+ "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8",
+ "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8",
+ "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8",
+ "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8",
+ "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8",
+ "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8",
+ "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8",
+ "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8",
+ "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8",
+ "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8",
+ "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8",
+ "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8",
+ "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8",
+ "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8",
+ "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8",
+ "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8",
+ "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8",
+ "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8",
+ "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8",
+ "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8",
+ "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8",
+ "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8",
+ "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8",
+ "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8",
+ "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8",
+ "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8",
+ "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8",
+ "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8",
+ "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8",
+ "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8",
+ "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8",
+ "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8",
+ "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8",
+ "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8",
+ "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8",
+ "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8",
+ "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8",
+ "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8",
+ "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8",
+ "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8",
+ "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8",
+ "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8",
+ "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8",
+ "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8",
+ "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8",
+ "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8",
+ "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8",
+ "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8",
+ "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8",
+ "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8",
+ "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8",
+ "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8",
+ "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8",
+ "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8",
+ "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8",
+ "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8",
+ "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8",
+ "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8",
+ "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8",
+ "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8",
+ "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8",
+ "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8",
+ "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8",
+ "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8",
+ "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8",
+ "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8",
+ "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8",
+ "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8",
+ "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8",
+ "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8",
+ "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8",
+ "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8",
+ "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8",
+ "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8",
+ "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8",
+ "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8",
+ "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8",
+ "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8",
+ "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8",
+ "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8",
+ "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8",
+ "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8",
+ "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8",
+ "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8",
+ "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8",
+ "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8",
+ "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8",
+ "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8",
+ "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8",
+ "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8",
+ "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8",
+ "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8",
+ "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8",
+ "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8",
+ "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8",
+ "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8",
+ "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8",
+ "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8",
+ "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8",
+ "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8",
+ "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8",
+ "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8",
+ "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8",
+ "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8",
+ "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8",
+ "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8",
+ "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8",
+ "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8",
+ "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8",
+ "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8",
+ "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8",
+ "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8",
+ "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8",
+ "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8",
+ "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8",
+ "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8",
+ "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8",
+ "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8",
+ "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8",
+ "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8",
+ "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8",
+ "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8",
+ "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8",
+ "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8",
+ "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8",
+ "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8",
+ "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8",
+ "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8",
+ "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8",
+ "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8",
+ "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8",
+ "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8",
+ "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8",
+ "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8",
+ "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8",
+ "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8",
+ "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8",
+ "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8",
+ "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8",
+ "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8",
+ "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8",
+ "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8",
+ "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8",
+ "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8",
+ "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8",
+ "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8",
+ "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8",
+ "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8",
+ "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8",
+ "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8",
+ "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8",
+ "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8",
+ "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8",
+ "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8",
+ "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8",
+ "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8",
+ "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8",
+ "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8",
+ "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8",
+ "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8",
+ "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8",
+ "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8",
+ "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8",
+ "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8",
+ "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8",
+ "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8",
+ "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8",
+ "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8",
+ "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8",
+ "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8",
+ "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8",
+ "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8",
+ "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8",
+ "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8",
+ "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8",
+ "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8",
+ "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8",
+ "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8",
+ "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8",
+ "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8",
+ "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8",
+ "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8",
+ "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8",
+ "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8",
+ "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8",
+ "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8",
+ "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8",
+ "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8",
+ "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8",
+ "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8",
+ "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8",
+ "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8",
+ "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8",
+ "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8",
+ "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8",
+ "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8",
+ "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8",
+ "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8",
+ "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8",
+ "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8",
+ "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8",
+ "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8",
+ "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8",
+ "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8",
+ "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8",
+ "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8",
+ "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8",
+ "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8",
+ "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8",
+ "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8",
+ "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8",
+ "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8",
+ "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8",
+ "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8",
+ "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8",
+ "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8",
+ "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8",
+ "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8",
+ "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8",
+ "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8",
+ "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8",
+ "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8",
+ "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8",
+ "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8",
+ "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8",
+ "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8",
+ "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8",
+ "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8",
+ "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8",
+ "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8",
+ "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8",
+ "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8",
+ "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8",
+ "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8",
+ "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8",
+ "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8",
+ "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8",
+ "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8",
+ "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8",
+ "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8",
+ "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8",
+ "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8",
+ "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8",
+ "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8",
+ "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8",
+ "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8",
+ "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8",
+ "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8",
+ "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8",
+ "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8",
+ "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8",
+ "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8",
+ "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8",
+ "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8",
+ "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8",
+ "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8",
+ "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8",
+ "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8",
+ "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8",
+ "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8",
+ "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8",
+ "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8",
+ "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8",
+ "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8",
+ "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8",
+ "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8",
+ "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8",
+ "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8",
+ "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8",
+ "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8",
+ "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8",
+ "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8",
+ "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8",
+ "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8",
+ "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8",
+ "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8",
+ "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8",
+ "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8",
+ "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8",
+ "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8",
+ "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8",
+ "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8",
+ "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8",
+ "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8",
+ "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8",
+ "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8",
+ "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8",
+ "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8",
+ "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8",
+ "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8",
+ "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8",
+ "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8",
+ "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8",
+ "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8",
+ "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8",
+ "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8",
+ "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8",
+ "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8",
+ "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8",
+ "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8",
+ "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8",
+ "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8",
+ "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8",
+ "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8",
+ "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8",
+ "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8",
+ "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8",
+ "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8",
+ "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8",
+ "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8",
+ "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8",
+ "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8",
+ "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8",
+ "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8",
+ "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8",
+ "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8",
+ "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8",
+ "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8",
+ "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8",
+ "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8",
+ "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8",
+ "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8",
+ "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8",
+ "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8",
+ "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8",
+ "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8",
+ "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8",
+ "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8",
+ "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8",
+ "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8",
+ "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8",
+ "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8",
+ "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8",
+ "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8",
+ "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8",
+ "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8",
+ "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8",
+ "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8",
+ "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8",
+ "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8",
+ "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8",
+ "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8",
+ "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8",
+ "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8",
+ "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8",
+ "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8",
+ "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8",
+ "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8",
+ "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8",
+ "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8",
+ "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8",
+ "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8",
+ "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8",
+ "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8",
+ "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8",
+ "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8",
+ "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8",
+ "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8",
+ "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8",
+ "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8",
+ "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8",
+ "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8",
+ "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8",
+ "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8",
+ "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8",
+ "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8",
+ "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8",
+ "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8",
+ "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8",
+ "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8",
+ "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8",
+ "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8",
+ "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8",
+ "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8",
+ "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8",
+ "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8",
+ "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8",
+ "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8",
+ "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8",
+ "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8",
+ "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8",
+ "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8",
+ "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8",
+ "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8",
+ "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8",
+ "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8",
+ "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8",
+ "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8",
+ "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8",
+ "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8",
+ "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8",
+ "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8",
+ "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8",
+ "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8",
+ "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8",
+ "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8",
+ "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8",
+ "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8",
+ "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8",
+ "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8",
+ "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8",
+ "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8",
+ "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8",
+ "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8",
+ "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8",
+ "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8",
+ "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8",
+ "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8",
+ "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8",
+ "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8",
+ "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8",
+ "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8",
+ "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8",
+ "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8",
+ "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8",
+ "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8",
+ "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8",
+ "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8",
+ "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8",
+ "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8",
+ "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8",
+ "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8",
+ "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8",
+ "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8",
+ "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8",
+ "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8",
+ "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8",
+ "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8",
+ "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8",
+ "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8",
+ "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8",
+ "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8",
+ "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8",
+ "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8",
+ "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8",
+ "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8",
+ "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8",
+ "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8",
+ "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8",
+ "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8",
+ "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8",
+ "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8",
+ "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8",
+ "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8",
+ "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8",
+ "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8",
+ "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8",
+ "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8",
+ "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8",
+ "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8",
+ "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8",
+ "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8",
+ "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8",
+ "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8",
+ "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8",
+ "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8",
+ "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8",
+ "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8",
+ "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8",
+ "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8",
+ "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8",
+ "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8",
+ "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8",
+ "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8",
+ "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8",
+ "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8",
+ "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8",
+ "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8",
+ "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8",
+ "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8",
+ "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8",
+ "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8",
+ "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8",
+ "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8",
+ "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8",
+ "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8",
+ "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8",
+ "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8",
+ "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8",
+ "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8",
+ "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8",
+ "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8",
+ "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8",
+ "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8",
+ "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8",
+ "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8",
+ "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8",
+ "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8",
+ "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8",
+ "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8",
+ "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8",
+ "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8",
+ "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8",
+ "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8",
+ "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8",
+ "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8",
+ "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8",
+ "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8",
+ "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8",
+ "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8",
+ "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8",
+ "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8",
+ "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8",
+ "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8",
+ "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8",
+ "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8",
+ "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8",
+ "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8",
+ "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8",
+ "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8",
+ "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8",
+ "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8",
+ "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8",
+ "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8",
+ "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8",
+ "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8",
+ "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8",
+ "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8",
+ "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8",
+ "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8",
+ "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8",
+ "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8",
+ "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8",
+ "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8",
+ "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8",
+ "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8",
+ "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8",
+ "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8",
+ "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8",
+ "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8",
+ "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8",
+ "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8",
+ "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8",
+ "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8",
+ "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8",
+ "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8",
+ "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8",
+ "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8",
+ "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8",
+ "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8",
+ "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8",
+ "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8",
+ "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8",
+ "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8",
+ "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8",
+ "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8",
+ "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8",
+ "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8",
+ "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8",
+ "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8",
+ "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8",
+ "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8",
+ "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8",
+ "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8",
+ "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8",
+ "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8",
+ "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8",
+ "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8",
+ "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8",
+ "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8",
+ "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8",
+ "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8",
+ "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8",
+ "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8",
+ "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8",
+ "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8",
+ "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8",
+ "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8",
+ "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8",
+ "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8",
+ "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8",
+ "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8",
+ "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8",
+ "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8",
+ "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8",
+ "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8",
+ "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8",
+ "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8",
+ "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8",
+ "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8",
+ "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8",
+ "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8",
+ "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8",
+ "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8",
+ "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8",
+ "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8",
+ "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8",
+ "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8",
+ "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8",
+ "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8",
+ "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8",
+ "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8",
+ "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8",
+ "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8",
+ "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8",
+ "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8",
+ "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8",
+ "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8",
+ "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8",
+ "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8",
+ "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8",
+ "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8",
+ "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8",
+ "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8",
+ "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8",
+ "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8",
+ "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8",
+ "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8",
+ "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8",
+ "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8",
+ "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8",
+ "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8",
+ "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8",
+ "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8",
+ "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8",
+ "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8",
+ "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8",
+ "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8",
+ "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8",
+ "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8",
+ "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8",
+ "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8",
+ "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8",
+ "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8",
+ "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8",
+ "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8",
+ "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8",
+ "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8",
+ "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8",
+ "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8",
+ "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8",
+ "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8",
+ "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8",
+ "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8",
+ "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8",
+ "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8",
+ "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8",
+ "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8",
+ "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8",
+ "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8",
+ "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8",
+ "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8",
+ "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8",
+ "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8",
+ "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8",
+ "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8",
+ "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8",
+ "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8",
+ "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8",
+ "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8",
+ "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8",
+ "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8",
+ "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8",
+ "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8",
+ "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8",
+ "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8",
+ "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8",
+ "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8",
+ "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8",
+ "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8",
+ "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8",
+ "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8",
+ "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8",
+ "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8",
+ "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8",
+ "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8",
+ "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8",
+ "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8",
+ "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8",
+ "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8",
+ "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8",
+ "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8",
+ "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8",
+ "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8",
+ "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8",
+ "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8",
+ "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8",
+ "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8",
+ "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8",
+ "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8",
+ "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8",
+ "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8",
+ "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8",
+ "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8",
+ "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8",
+ "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8",
+ "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8",
+ "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8",
+ "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8",
+ "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8",
+ "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8",
+ "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8",
+ "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8",
+ "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8",
+ "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8",
+ "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8",
+ "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8",
+ "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8",
+ "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8",
+ "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8",
+ "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8",
+ "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8",
+ "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8",
+ "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8",
+ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8"
+ }
+ },
+ "dependabot-alerts-for-organization": {
+ "value": [
+ {
+ "number": 2,
+ "state": "dismissed",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-rf4j-j272-fj86",
+ "cve_id": "CVE-2018-6188",
+ "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
+ "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
+ "first_patched_version": {
+ "identifier": "1.11.10"
+ }
+ }
+ ],
+ "severity": "high",
+ "cvss": {
+ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
+ "score": 7.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-200",
+ "name": "Exposure of Sensitive Information to an Unauthorized Actor"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-rf4j-j272-fj86"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2018-6188"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
+ },
+ {
+ "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
+ },
+ {
+ "url": "https://usn.ubuntu.com/3559-1/"
+ },
+ {
+ "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
+ },
+ {
+ "url": "http://www.securitytracker.com/id/1040422"
+ }
+ ],
+ "published_at": "2018-10-03T21:13:54Z",
+ "updated_at": "2022-04-26T18:35:37Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2",
+ "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2",
+ "created_at": "2022-06-15T07:43:03Z",
+ "updated_at": "2022-08-23T14:29:47Z",
+ "dismissed_at": "2022-08-23T14:29:47Z",
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_reason": "tolerable_risk",
+ "dismissed_comment": "This alert is accurate but we use a sanitizer.",
+ "fixed_at": null,
+ "repository": {
+ "id": 217723378,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+ "name": "octo-repo",
+ "full_name": "octo-org/octo-repo",
+ "owner": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "private": true,
+ "html_url": "https://github.com/octo-org/octo-repo",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/octo-repo",
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}"
+ }
+ },
+ {
+ "number": 1,
+ "state": "open",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-8f4m-hccc-8qph",
+ "cve_id": "CVE-2021-20191",
+ "summary": "Insertion of Sensitive Information into Log File in ansible",
+ "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.9.0, < 2.9.18",
+ "first_patched_version": {
+ "identifier": "2.9.18"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.10.0, < 2.10.7",
+ "first_patched_version": {
+ "identifier": "2.10.7"
+ }
+ }
+ ],
+ "severity": "medium",
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
+ "score": 5.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-532",
+ "name": "Insertion of Sensitive Information into Log File"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-8f4m-hccc-8qph"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2021-20191"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"
+ },
+ {
+ "url": "https://access.redhat.com/security/cve/cve-2021-20191"
+ },
+ {
+ "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
+ }
+ ],
+ "published_at": "2021-06-01T17:38:00Z",
+ "updated_at": "2021-08-12T23:06:00Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1",
+ "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1",
+ "created_at": "2022-06-14T15:21:52Z",
+ "updated_at": "2022-06-14T15:21:52Z",
+ "dismissed_at": null,
+ "dismissed_by": null,
+ "dismissed_reason": null,
+ "dismissed_comment": null,
+ "fixed_at": null,
+ "repository": {
+ "id": 664700648,
+ "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=",
+ "name": "hello-world",
+ "full_name": "octo-org/hello-world",
+ "owner": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "private": true,
+ "html_url": "https://github.com/octo-org/hello-world",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/hello-world",
+ "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors",
+ "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments",
+ "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads",
+ "events_url": "https://api.github.com/repos/octo-org/hello-world/events",
+ "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks",
+ "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}",
+ "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages",
+ "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges",
+ "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers",
+ "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription",
+ "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags",
+ "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams",
+ "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}"
+ }
+ }
+ ]
+ },
+ "organization-secret-scanning-alert-list": {
+ "value": [
+ {
+ "number": 2,
+ "created_at": "2020-11-06T18:48:51Z",
+ "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2",
+ "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations",
+ "state": "resolved",
+ "resolution": "false_positive",
+ "resolved_at": "2020-11-07T02:47:13Z",
+ "resolved_by": {
+ "login": "monalisa",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjI=",
+ "avatar_url": "https://alambic.github.com/avatars/u/2?",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "secret_type": "adafruit_io_key",
+ "secret_type_display_name": "Adafruit IO Key",
+ "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "push_protection_bypassed_by": {
+ "login": "monalisa",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjI=",
+ "avatar_url": "https://alambic.github.com/avatars/u/2?",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "push_protection_bypassed": true,
+ "push_protection_bypassed_at": "2020-11-06T21:48:51Z",
+ "resolution_comment": "Example comment",
+ "validity": "active"
+ },
+ {
+ "number": 1,
+ "created_at": "2020-11-06T18:18:30Z",
+ "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1",
+ "html_url": "https://github.com/owner/repo/security/secret-scanning/1",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations",
+ "state": "open",
+ "resolution": null,
+ "resolved_at": null,
+ "resolved_by": null,
+ "secret_type": "mailchimp_api_key",
+ "secret_type_display_name": "Mailchimp API Key",
+ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "push_protection_bypassed_by": null,
+ "push_protection_bypassed": false,
+ "push_protection_bypassed_at": null,
+ "resolution_comment": null,
+ "validity": "unknown"
+ }
+ ]
+ },
+ "public-events-items": {
+ "value": [
+ {
+ "id": "22249084947",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-07T07:50:26Z"
+ }
+ ]
+ },
+ "feed": {
+ "value": {
+ "timeline_url": "https://github.com/timeline",
+ "user_url": "https://github.com/{user}",
+ "current_user_public_url": "https://github.com/octocat",
+ "current_user_url": "https://github.com/octocat.private?token=abc123",
+ "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123",
+ "current_user_organization_url": "",
+ "current_user_organization_urls": [
+ "https://github.com/organizations/github/octocat.private.atom?token=abc123"
+ ],
+ "security_advisories_url": "https://github.com/security-advisories",
+ "_links": {
+ "timeline": {
+ "href": "https://github.com/timeline",
+ "type": "application/atom+xml"
+ },
+ "user": {
+ "href": "https://github.com/{user}",
+ "type": "application/atom+xml"
+ },
+ "current_user_public": {
+ "href": "https://github.com/octocat",
+ "type": "application/atom+xml"
+ },
+ "current_user": {
+ "href": "https://github.com/octocat.private?token=abc123",
+ "type": "application/atom+xml"
+ },
+ "current_user_actor": {
+ "href": "https://github.com/octocat.private.actor?token=abc123",
+ "type": "application/atom+xml"
+ },
+ "current_user_organization": {
+ "href": "",
+ "type": ""
+ },
+ "current_user_organizations": [
+ {
+ "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
+ "type": "application/atom+xml"
+ }
+ ],
+ "security_advisories": {
+ "href": "https://github.com/security-advisories",
+ "type": "application/atom+xml"
+ }
+ }
+ }
+ },
+ "base-gist-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ },
+ "gist": {
+ "value": {
+ "url": "https://api.github.com/gists/2decf6c462d9b4418f2",
+ "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",
+ "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",
+ "id": "2decf6c462d9b4418f2",
+ "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",
+ "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
+ "files": {
+ "README.md": {
+ "filename": "README.md",
+ "type": "text/markdown",
+ "language": "Markdown",
+ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",
+ "size": 23,
+ "truncated": false,
+ "content": "Hello world from GitHub"
+ }
+ },
+ "public": true,
+ "created_at": "2022-09-20T12:11:58Z",
+ "updated_at": "2022-09-21T10:28:06Z",
+ "description": "An updated gist description.",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",
+ "owner": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgDOBhHyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "forks": [
+
+ ],
+ "history": [
+ {
+ "user": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "version": "468aac8caed5f0c3b859b8286968",
+ "committed_at": "2022-09-21T10:28:06Z",
+ "change_status": {
+ "total": 2,
+ "additions": 1,
+ "deletions": 1
+ },
+ "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
+ }
+ ],
+ "truncated": false
+ }
+ },
+ "delete-gist-file": {
+ "value": {
+ "url": "https://api.github.com/gists/2decf6c462d9b4418f2",
+ "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",
+ "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",
+ "id": "2decf6c462d9b4418f2",
+ "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy",
+ "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
+ "files": null,
+ "public": true,
+ "created_at": "2022-09-20T12:11:58Z",
+ "updated_at": "2022-09-21T10:28:06Z",
+ "description": "A gist description.",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",
+ "owner": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgDOBhHyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "forks": [
+
+ ],
+ "history": [
+ {
+ "user": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "version": "9cc352a89178a6d4",
+ "committed_at": "2022-09-21T10:28:06Z",
+ "change_status": {
+ "total": 1,
+ "additions": 0,
+ "deletions": 1
+ },
+ "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
+ }
+ ],
+ "truncated": false
+ }
+ },
+ "rename-gist-file": {
+ "value": {
+ "url": "https://api.github.com/gists/2decf6c462d9b4418f2",
+ "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",
+ "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",
+ "id": "2decf6c462d9b4418f2",
+ "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy",
+ "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
+ "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
+ "files": {
+ "goodbye.py": {
+ "filename": "goodbye.py",
+ "type": "application/x-python",
+ "language": "Python",
+ "raw_url": "https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py",
+ "size": 4,
+ "truncated": false,
+ "content": "# Hello world"
+ }
+ },
+ "public": true,
+ "created_at": "2022-09-20T12:11:58Z",
+ "updated_at": "2022-09-21T10:28:06Z",
+ "description": "A gist description.",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",
+ "owner": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgDOBhHyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "forks": [
+
+ ],
+ "history": [
+ {
+ "user": {
+ "login": "monalisa",
+ "id": 104456405,
+ "node_id": "U_kgyLQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "version": "468aac8caed5f0c3b859b8286968",
+ "committed_at": "2022-09-21T10:28:06Z",
+ "change_status": {
+ "total": 0,
+ "additions": 0,
+ "deletions": 0
+ },
+ "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
+ }
+ ],
+ "truncated": false
+ }
+ },
+ "gist-comment-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDExOkdpc3RDb21tZW50MQ==",
+ "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
+ "body": "Just commenting for the sake of commenting",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-18T23:23:56Z",
+ "updated_at": "2011-04-18T23:23:56Z",
+ "author_association": "COLLABORATOR"
+ }
+ ]
+ },
+ "gist-comment": {
+ "value": {
+ "id": 1,
+ "node_id": "MDExOkdpc3RDb21tZW50MQ==",
+ "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
+ "body": "Just commenting for the sake of commenting",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-18T23:23:56Z",
+ "updated_at": "2011-04-18T23:23:56Z",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "gist-commit-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",
+ "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "change_status": {
+ "deletions": 0,
+ "additions": 180,
+ "total": 180
+ },
+ "committed_at": "2010-04-14T02:15:15Z"
+ }
+ ]
+ },
+ "gist-fork-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 1,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "base-gist": {
+ "value": {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ },
+ "gitignore-template": {
+ "value": {
+ "name": "C",
+ "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
+ }
+ },
+ "repository-paginated-2": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ]
+ }
+ },
+ "issue-with-repo-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ },
+ "author_association": "COLLABORATOR"
+ }
+ ]
+ },
+ "license-simple-items": {
+ "value": [
+ {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "lgpl-3.0",
+ "name": "GNU Lesser General Public License v3.0",
+ "spdx_id": "LGPL-3.0",
+ "url": "https://api.github.com/licenses/lgpl-3.0",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "mpl-2.0",
+ "name": "Mozilla Public License 2.0",
+ "spdx_id": "MPL-2.0",
+ "url": "https://api.github.com/licenses/mpl-2.0",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "agpl-3.0",
+ "name": "GNU Affero General Public License v3.0",
+ "spdx_id": "AGPL-3.0",
+ "url": "https://api.github.com/licenses/agpl-3.0",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "unlicense",
+ "name": "The Unlicense",
+ "spdx_id": "Unlicense",
+ "url": "https://api.github.com/licenses/unlicense",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "apache-2.0",
+ "name": "Apache License 2.0",
+ "spdx_id": "Apache-2.0",
+ "url": "https://api.github.com/licenses/apache-2.0",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ {
+ "key": "gpl-3.0",
+ "name": "GNU General Public License v3.0",
+ "spdx_id": "GPL-3.0",
+ "url": "https://api.github.com/licenses/gpl-3.0",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ ]
+ },
+ "license": {
+ "value": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "http://choosealicense.com/licenses/mit/",
+ "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.",
+ "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.",
+ "permissions": [
+ "commercial-use",
+ "modifications",
+ "distribution",
+ "sublicense",
+ "private-use"
+ ],
+ "conditions": [
+ "include-copyright"
+ ],
+ "limitations": [
+ "no-liability"
+ ],
+ "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
+ "featured": true
+ }
+ },
+ "marketplace-purchase": {
+ "value": {
+ "url": "https://api.github.com/orgs/github",
+ "type": "Organization",
+ "id": 4,
+ "login": "github",
+ "organization_billing_email": "billing@github.com",
+ "email": "billing@github.com",
+ "marketplace_pending_change": {
+ "effective_date": "2017-11-11T00:00:00Z",
+ "unit_count": null,
+ "id": 77,
+ "plan": {
+ "url": "https://api.github.com/marketplace_listing/plans/1111",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts",
+ "id": 1111,
+ "number": 2,
+ "name": "Startup",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 699,
+ "yearly_price_in_cents": 7870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "state": "published",
+ "unit_name": null,
+ "bullets": [
+ "Up to 10 private repositories",
+ "3 concurrent builds"
+ ]
+ }
+ },
+ "marketplace_purchase": {
+ "billing_cycle": "monthly",
+ "next_billing_date": "2017-11-11T00:00:00Z",
+ "unit_count": null,
+ "on_free_trial": true,
+ "free_trial_ends_on": "2017-11-11T00:00:00Z",
+ "updated_at": "2017-11-02T01:12:12Z",
+ "plan": {
+ "url": "https://api.github.com/marketplace_listing/plans/1313",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
+ "id": 1313,
+ "number": 3,
+ "name": "Pro",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 1099,
+ "yearly_price_in_cents": 11870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "unit_name": null,
+ "state": "published",
+ "bullets": [
+ "Up to 25 private repositories",
+ "11 concurrent builds"
+ ]
+ }
+ }
+ }
+ },
+ "marketplace-listing-plan-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/marketplace_listing/plans/1313",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
+ "id": 1313,
+ "number": 3,
+ "name": "Pro",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 1099,
+ "yearly_price_in_cents": 11870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "unit_name": null,
+ "state": "published",
+ "bullets": [
+ "Up to 25 private repositories",
+ "11 concurrent builds"
+ ]
+ }
+ ]
+ },
+ "marketplace-purchase-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/orgs/github",
+ "type": "Organization",
+ "id": 4,
+ "login": "github",
+ "organization_billing_email": "billing@github.com",
+ "marketplace_pending_change": {
+ "effective_date": "2017-11-11T00:00:00Z",
+ "unit_count": null,
+ "id": 77,
+ "plan": {
+ "url": "https://api.github.com/marketplace_listing/plans/1111",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts",
+ "id": 1111,
+ "number": 2,
+ "name": "Startup",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 699,
+ "yearly_price_in_cents": 7870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "state": "published",
+ "unit_name": null,
+ "bullets": [
+ "Up to 10 private repositories",
+ "3 concurrent builds"
+ ]
+ }
+ },
+ "marketplace_purchase": {
+ "billing_cycle": "monthly",
+ "next_billing_date": "2017-11-11T00:00:00Z",
+ "unit_count": null,
+ "on_free_trial": true,
+ "free_trial_ends_on": "2017-11-11T00:00:00Z",
+ "updated_at": "2017-11-02T01:12:12Z",
+ "plan": {
+ "url": "https://api.github.com/marketplace_listing/plans/1313",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
+ "id": 1313,
+ "number": 3,
+ "name": "Pro",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 1099,
+ "yearly_price_in_cents": 11870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "unit_name": null,
+ "state": "published",
+ "bullets": [
+ "Up to 25 private repositories",
+ "11 concurrent builds"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "api-overview": {
+ "value": {
+ "verifiable_password_authentication": true,
+ "ssh_key_fingerprints": {
+ "SHA256_RSA": 1234567890,
+ "SHA256_DSA": 1234567890,
+ "SHA256_ECDSA": 1234567890,
+ "SHA256_ED25519": 1234567890
+ },
+ "ssh_keys": [
+ "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+ ],
+ "hooks": [
+ "192.0.2.1"
+ ],
+ "github_enterprise_importer": [
+ "192.0.2.1"
+ ],
+ "web": [
+ "192.0.2.1"
+ ],
+ "api": [
+ "192.0.2.1"
+ ],
+ "git": [
+ "192.0.2.1"
+ ],
+ "packages": [
+ "192.0.2.1"
+ ],
+ "pages": [
+ "192.0.2.1"
+ ],
+ "importer": [
+ "192.0.2.1"
+ ],
+ "actions": [
+ "192.0.2.1"
+ ],
+ "dependabot": [
+ "192.0.2.1"
+ ],
+ "domains": {
+ "website": [
+ "*.example.com"
+ ],
+ "codespaces": [
+ "*.example.com"
+ ],
+ "copilot": [
+ "*.example.com"
+ ],
+ "packages": [
+ "*.example.com"
+ ]
+ }
+ }
+ },
+ "public-repo-events-items": {
+ "value": [
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22237752260",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/rrubenich",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-08T23:29:25Z"
+ }
+ ]
+ },
+ "thread-items": {
+ "value": [
+ {
+ "id": "1",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "subject": {
+ "title": "Greetings",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
+ "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
+ "type": "Issue"
+ },
+ "reason": "subscribed",
+ "unread": true,
+ "updated_at": "2014-11-07T22:01:45Z",
+ "last_read_at": "2014-11-07T22:01:45Z",
+ "url": "https://api.github.com/notifications/threads/1",
+ "subscription_url": "https://api.github.com/notifications/threads/1/subscription"
+ }
+ ]
+ },
+ "notifications-mark-read": {
+ "value": {
+ "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background."
+ }
+ },
+ "thread": {
+ "value": {
+ "id": "1",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "subject": {
+ "title": "Greetings",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
+ "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
+ "type": "Issue"
+ },
+ "reason": "subscribed",
+ "unread": true,
+ "updated_at": "2014-11-07T22:01:45Z",
+ "last_read_at": "2014-11-07T22:01:45Z",
+ "url": "https://api.github.com/notifications/threads/1",
+ "subscription_url": "https://api.github.com/notifications/threads/1/subscription"
+ }
+ },
+ "thread-subscription": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/notifications/threads/1/subscription",
+ "thread_url": "https://api.github.com/notifications/threads/1"
+ }
+ },
+ "octocat": {
+ "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n"
+ },
+ "organization-simple-items": {
+ "value": [
+ {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ }
+ ]
+ },
+ "organization-full": {
+ "value": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "twitter_username": "github",
+ "is_verified": true,
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "type": "Organization",
+ "total_private_repos": 100,
+ "owned_private_repos": 100,
+ "private_gists": 81,
+ "disk_usage": 10000,
+ "collaborators": 8,
+ "billing_email": "mona@github.com",
+ "plan": {
+ "name": "Medium",
+ "space": 400,
+ "private_repos": 20,
+ "filled_seats": 4,
+ "seats": 5
+ },
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "two_factor_requirement_enabled": true,
+ "members_allowed_repository_creation_type": "all",
+ "members_can_create_public_repositories": false,
+ "members_can_create_private_repositories": false,
+ "members_can_create_internal_repositories": false,
+ "members_can_create_pages": true,
+ "members_can_create_public_pages": true,
+ "members_can_create_private_pages": true,
+ "members_can_fork_private_repositories": false,
+ "web_commit_signoff_required": false,
+ "updated_at": "2014-03-03T18:58:10Z",
+ "dependency_graph_enabled_for_new_repositories": false,
+ "dependabot_alerts_enabled_for_new_repositories": false,
+ "dependabot_security_updates_enabled_for_new_repositories": false,
+ "advanced_security_enabled_for_new_repositories": false,
+ "secret_scanning_enabled_for_new_repositories": false,
+ "secret_scanning_push_protection_enabled_for_new_repositories": false,
+ "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md",
+ "secret_scanning_push_protection_custom_link_enabled": false
+ }
+ },
+ "actions-cache-usage-org-enterprise": {
+ "value": {
+ "total_active_caches_size_in_bytes": 3344284,
+ "total_active_caches_count": 5
+ }
+ },
+ "org-actions-cache-usage-by-repo": {
+ "value": {
+ "total_count": 2,
+ "repository_cache_usages": [
+ {
+ "full_name": "octo-org/Hello-World",
+ "active_caches_size_in_bytes": 2322142,
+ "active_caches_count": 3
+ },
+ {
+ "full_name": "octo-org/server",
+ "active_caches_size_in_bytes": 1022142,
+ "active_caches_count": 2
+ }
+ ]
+ }
+ },
+ "oidc-custom-sub": {
+ "value": {
+ "include_claim_keys": [
+ "repo",
+ "context"
+ ]
+ }
+ },
+ "actions-organization-permissions": {
+ "value": {
+ "enabled_repositories": "all",
+ "allowed_actions": "selected",
+ "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions"
+ }
+ },
+ "repository-paginated": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ]
+ }
+ },
+ "selected-actions": {
+ "value": {
+ "github_owned_allowed": true,
+ "verified_allowed": false,
+ "patterns_allowed": [
+ "monalisa/octocat@*",
+ "docker/*"
+ ]
+ }
+ },
+ "actions-default-workflow-permissions": {
+ "summary": "Give read-only permission, and allow approving PRs.",
+ "value": {
+ "default_workflow_permissions": "read",
+ "can_approve_pull_request_reviews": true
+ }
+ },
+ "runner-paginated": {
+ "value": {
+ "total_count": 2,
+ "runners": [
+ {
+ "id": 23,
+ "name": "linux_runner",
+ "os": "linux",
+ "status": "online",
+ "busy": true,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 11,
+ "name": "Linux",
+ "type": "read-only"
+ }
+ ]
+ },
+ {
+ "id": 24,
+ "name": "mac_runner",
+ "os": "macos",
+ "status": "offline",
+ "busy": false,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 20,
+ "name": "macOS",
+ "type": "read-only"
+ },
+ {
+ "id": 21,
+ "name": "no-gpu",
+ "type": "custom"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "runner-application-items": {
+ "value": [
+ {
+ "os": "osx",
+ "architecture": "x64",
+ "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz",
+ "filename": "actions-runner-osx-x64-2.164.0.tar.gz"
+ },
+ {
+ "os": "linux",
+ "architecture": "x64",
+ "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz",
+ "filename": "actions-runner-linux-x64-2.164.0.tar.gz"
+ },
+ {
+ "os": "linux",
+ "architecture": "arm",
+ "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz",
+ "filename": "actions-runner-linux-arm-2.164.0.tar.gz"
+ },
+ {
+ "os": "win",
+ "architecture": "x64",
+ "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip",
+ "filename": "actions-runner-win-x64-2.164.0.zip"
+ },
+ {
+ "os": "linux",
+ "architecture": "arm64",
+ "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz",
+ "filename": "actions-runner-linux-arm64-2.164.0.tar.gz"
+ }
+ ]
+ },
+ "runner-jitconfig": {
+ "value": {
+ "runner": {
+ "id": 23,
+ "name": "New runner",
+ "os": "unknown",
+ "status": "offline",
+ "busy": false,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 20,
+ "name": "macOS",
+ "type": "read-only"
+ },
+ {
+ "id": 21,
+ "name": "no-gpu",
+ "type": "custom"
+ }
+ ]
+ },
+ "encoded_jit_config": "abc123"
+ }
+ },
+ "authentication-token": {
+ "value": {
+ "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6",
+ "expires_at": "2020-01-22T12:13:35.123-08:00"
+ }
+ },
+ "authentication-token-2": {
+ "value": {
+ "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6",
+ "expires_at": "2020-01-29T12:13:35.123-08:00"
+ }
+ },
+ "runner": {
+ "value": {
+ "id": 23,
+ "name": "MBP",
+ "os": "macos",
+ "status": "online",
+ "busy": true,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 20,
+ "name": "macOS",
+ "type": "read-only"
+ },
+ {
+ "id": 21,
+ "name": "no-gpu",
+ "type": "custom"
+ }
+ ]
+ }
+ },
+ "runner-labels": {
+ "value": {
+ "total_count": 4,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 20,
+ "name": "macOS",
+ "type": "read-only"
+ },
+ {
+ "id": 21,
+ "name": "no-gpu",
+ "type": "custom"
+ }
+ ]
+ }
+ },
+ "runner-labels-readonly": {
+ "value": {
+ "total_count": 3,
+ "labels": [
+ {
+ "id": 5,
+ "name": "self-hosted",
+ "type": "read-only"
+ },
+ {
+ "id": 7,
+ "name": "X64",
+ "type": "read-only"
+ },
+ {
+ "id": 20,
+ "name": "macOS",
+ "type": "read-only"
+ }
+ ]
+ }
+ },
+ "organization-actions-secret-paginated": {
+ "value": {
+ "total_count": 3,
+ "secrets": [
+ {
+ "name": "GIST_ID",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "private"
+ },
+ {
+ "name": "DEPLOY_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "all"
+ },
+ {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
+ }
+ ]
+ }
+ },
+ "actions-public-key": {
+ "value": {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+ }
+ },
+ "organization-actions-secret": {
+ "value": {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
+ }
+ },
+ "public-repository-paginated": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ }
+ ]
+ }
+ },
+ "organization-actions-variables-paginated": {
+ "value": {
+ "total_count": 3,
+ "variables": [
+ {
+ "name": "USERNAME",
+ "value": "octocat",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "private"
+ },
+ {
+ "name": "ACTIONS_RUNNER_DEBUG",
+ "value": true,
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "all"
+ },
+ {
+ "name": "ADMIN_EMAIL",
+ "value": "octocat@github.com",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories"
+ }
+ ]
+ }
+ },
+ "organization-actions-variable": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories"
+ }
+ },
+ "simple-user-items": {
+ "value": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ]
+ },
+ "code-scanning-organization-alert-items": {
+ "value": [
+ {
+ "number": 4,
+ "created_at": "2020-02-13T12:29:18Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/4",
+ "state": "open",
+ "dismissed_by": null,
+ "dismissed_at": null,
+ "dismissed_reason": null,
+ "dismissed_comment": null,
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "description": "Arbitrary file write during zip extraction",
+ "name": "js/zipslip"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "open",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "spec-main/api-session-spec.ts",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+ "test"
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks"
+ }
+ },
+ {
+ "number": 3,
+ "created_at": "2020-02-13T12:29:18Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/3",
+ "state": "dismissed",
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_at": "2020-02-14T12:29:18Z",
+ "dismissed_reason": "false positive",
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "description": "Arbitrary file write during zip extraction",
+ "name": "js/zipslip"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "open",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "lib/ab12-gen.js",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks"
+ }
+ }
+ ]
+ },
+ "codespaces-list": {
+ "value": {
+ "total_count": 3,
+ "codespaces": [
+ {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-g4wpq6h95q",
+ "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
+ "recent_folders": [
+
+ ]
+ },
+ {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-3f89ada1j3",
+ "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/foobar/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop",
+ "recent_folders": [
+
+ ]
+ },
+ {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-f8adfad99a",
+ "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop",
+ "recent_folders": [
+
+ ]
+ }
+ ]
+ }
+ },
+ "repo-codespaces-secret-paginated": {
+ "value": {
+ "total_count": 2,
+ "secrets": [
+ {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "all"
+ },
+ {
+ "name": "GIST_ID",
+ "created_at": "2020-01-10T10:59:22Z",
+ "updated_at": "2020-01-11T11:59:22Z",
+ "visibility": "all"
+ }
+ ]
+ }
+ },
+ "codespaces-public-key": {
+ "value": {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+ }
+ },
+ "repo-codespaces-secret": {
+ "value": {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "all"
+ }
+ },
+ "copilot-organization-details": {
+ "value": {
+ "seat_breakdown": {
+ "total": 12,
+ "added_this_cycle": 9,
+ "pending_invitation": 0,
+ "pending_cancellation": 0,
+ "active_this_cycle": 12,
+ "inactive_this_cycle": 11
+ },
+ "seat_management_setting": "assign_selected",
+ "public_code_suggestions": "block"
+ }
+ },
+ "copilot-seats-list": {
+ "value": {
+ "total_seats": 2,
+ "seats": [
+ {
+ "created_at": "2021-08-03T18:00:00-06:00",
+ "updated_at": "2021-09-23T15:00:00-06:00",
+ "pending_cancellation_date": null,
+ "last_activity_at": "2021-10-14T00:53:32-06:00",
+ "last_activity_editor": "vscode/1.77.3/copilot/1.86.82",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assigning_team": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ },
+ {
+ "created_at": "2021-09-23T18:00:00-06:00",
+ "updated_at": "2021-09-23T15:00:00-06:00",
+ "pending_cancellation_date": "2021-11-01",
+ "last_activity_at": "2021-10-13T00:53:32-06:00",
+ "last_activity_editor": "vscode/1.77.3/copilot/1.86.82",
+ "assignee": {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ76VNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ }
+ },
+ "organization-dependabot-secret-paginated": {
+ "value": {
+ "total_count": 3,
+ "secrets": [
+ {
+ "name": "MY_ARTIFACTORY_PASSWORD",
+ "created_at": "2021-08-10T14:59:22Z",
+ "updated_at": "2021-12-10T14:59:22Z",
+ "visibility": "private"
+ },
+ {
+ "name": "NPM_TOKEN",
+ "created_at": "2021-08-10T14:59:22Z",
+ "updated_at": "2021-12-10T14:59:22Z",
+ "visibility": "all"
+ },
+ {
+ "name": "GH_TOKEN",
+ "created_at": "2021-08-10T14:59:22Z",
+ "updated_at": "2021-12-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories"
+ }
+ ]
+ }
+ },
+ "dependabot-public-key": {
+ "value": {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+ }
+ },
+ "organization-dependabot-secret": {
+ "value": {
+ "name": "NPM_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories"
+ }
+ },
+ "packages-for-org": {
+ "value": [
+ {
+ "id": 197,
+ "name": "hello_docker",
+ "package_type": "container",
+ "owner": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "version_count": 1,
+ "visibility": "private",
+ "url": "https://api.github.com/orgs/github/packages/container/hello_docker",
+ "created_at": "2020-05-19T22:19:11Z",
+ "updated_at": "2020-05-19T22:19:11Z",
+ "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker"
+ },
+ {
+ "id": 198,
+ "name": "goodbye_docker",
+ "package_type": "container",
+ "owner": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "version_count": 2,
+ "visibility": "private",
+ "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker",
+ "created_at": "2020-05-20T22:19:11Z",
+ "updated_at": "2020-05-20T22:19:11Z",
+ "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker"
+ }
+ ]
+ },
+ "public-org-events-items": {
+ "value": [
+ {
+ "id": "22237752260",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octo-org/octo-repo",
+ "url": "https://api.github.com/repos/octo-org/octo-repo"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-08T23:29:25Z"
+ },
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octo-org/octo-repo",
+ "url": "https://api.github.com/repos/octo-org/oct-repo"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ }
+ ]
+ },
+ "organization-invitation-items": {
+ "value": [
+ {
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
+ }
+ ]
+ },
+ "org-hook-items": {
+ "value": [
+ {
+ "id": 1,
+ "url": "https://api.github.com/orgs/octocat/hooks/1",
+ "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
+ "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
+ "name": "web",
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "active": true,
+ "config": {
+ "url": "http://example.com",
+ "content_type": "json"
+ },
+ "updated_at": "2011-09-06T20:39:23Z",
+ "created_at": "2011-09-06T17:26:27Z",
+ "type": "Organization"
+ }
+ ]
+ },
+ "org-hook": {
+ "value": {
+ "id": 1,
+ "url": "https://api.github.com/orgs/octocat/hooks/1",
+ "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
+ "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
+ "name": "web",
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "active": true,
+ "config": {
+ "url": "http://example.com",
+ "content_type": "json"
+ },
+ "updated_at": "2011-09-06T20:39:23Z",
+ "created_at": "2011-09-06T17:26:27Z",
+ "type": "Organization"
+ }
+ },
+ "org-hook-2": {
+ "value": {
+ "id": 1,
+ "url": "https://api.github.com/orgs/octocat/hooks/1",
+ "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
+ "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
+ "name": "web",
+ "events": [
+ "pull_request"
+ ],
+ "active": true,
+ "config": {
+ "url": "http://example.com",
+ "content_type": "json"
+ },
+ "updated_at": "2011-09-06T20:39:23Z",
+ "created_at": "2011-09-06T17:26:27Z",
+ "type": "Organization"
+ }
+ },
+ "installation": {
+ "value": {
+ "id": 1,
+ "account": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "created_at": "2018-02-09T20:51:14Z",
+ "updated_at": "2018-02-09T20:51:14Z",
+ "single_file_name": "config.yml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ }
+ },
+ "installation-paginated": {
+ "value": {
+ "total_count": 1,
+ "installations": [
+ {
+ "id": 25381,
+ "account": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "repository_selection": "selected",
+ "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/octo-org/settings/installations/25381",
+ "app_id": 2218,
+ "target_id": 6811672,
+ "target_type": "Organization",
+ "permissions": {
+ "deployments": "write",
+ "metadata": "read",
+ "pull_requests": "read",
+ "statuses": "read"
+ },
+ "events": [
+ "deployment",
+ "deployment_status"
+ ],
+ "created_at": "2017-05-16T08:47:09.000-07:00",
+ "updated_at": "2017-06-06T11:23:23.000-07:00",
+ "single_file_name": "config.yml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ }
+ ]
+ }
+ },
+ "interaction-limit-response": {
+ "value": {
+ "limit": "collaborators_only",
+ "origin": "organization",
+ "expires_at": "2018-08-17T04:18:39Z"
+ }
+ },
+ "organization-invitation": {
+ "value": {
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "inviter": {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
+ }
+ },
+ "team-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ]
+ },
+ "codespace": {
+ "value": {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-g4wpq6h95q",
+ "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "retention_period_minutes": 43200,
+ "retention_expires_at": null,
+ "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "recent_folders": [
+
+ ],
+ "template": null
+ }
+ },
+ "copilot-seat-detail-active": {
+ "value": {
+ "created_at": "2021-08-03T18:00:00-06:00",
+ "updated_at": "2021-09-23T15:00:00-06:00",
+ "pending_cancellation_date": null,
+ "last_activity_at": "2021-10-14T00:53:32-06:00",
+ "last_activity_editor": "vscode/1.77.3/copilot/1.86.82",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assigning_team": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ }
+ },
+ "org-membership-response-if-user-has-an-active-admin-membership-with-organization": {
+ "summary": "Response if user has an active admin membership with organization",
+ "value": {
+ "url": "https://api.github.com/orgs/octocat/memberships/defunkt",
+ "state": "active",
+ "role": "admin",
+ "organization_url": "https://api.github.com/orgs/octocat",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "migration-with-short-org-items": {
+ "value": [
+ {
+ "id": 79,
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "pending",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ]
+ },
+ "migration-with-short-org-2": {
+ "value": {
+ "id": 79,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "pending",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00"
+ }
+ },
+ "migration-with-short-org": {
+ "value": {
+ "id": 79,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "exported",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00"
+ }
+ },
+ "minimal-repository-items": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "security_and_analysis": {
+ "advanced_security": {
+ "status": "enabled"
+ },
+ "secret_scanning": {
+ "status": "enabled"
+ },
+ "secret_scanning_push_protection": {
+ "status": "disabled"
+ }
+ }
+ }
+ ]
+ },
+ "organization-fine-grained-permission-example": {
+ "value": [
+ {
+ "name": "read_organization_custom_org_role",
+ "description": "View organization roles"
+ },
+ {
+ "name": "write_organization_custom_org_role",
+ "description": "Manage custom organization roles"
+ }
+ ]
+ },
+ "organization-role-list": {
+ "value": {
+ "total_count": 2,
+ "roles": [
+ {
+ "id": 8030,
+ "name": "Custom Role Manager",
+ "description": "Permissions to manage custom roles within an org",
+ "permissions": [
+ "write_organization_custom_repo_role",
+ "write_organization_custom_org_role",
+ "read_organization_custom_repo_role",
+ "read_organization_custom_org_role"
+ ],
+ "organization": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "created_at": "2022-07-04T22:19:11Z",
+ "updated_at": "2022-07-04T22:20:11Z"
+ },
+ {
+ "id": 8031,
+ "name": "Auditor",
+ "description": "Permissions to read the organization audit log",
+ "permissions": [
+ "read_audit_logs"
+ ],
+ "organization": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "created_at": "2022-07-04T22:19:11Z",
+ "updated_at": "2022-07-04T22:20:11Z"
+ }
+ ]
+ }
+ },
+ "organization-role": {
+ "value": {
+ "id": 8030,
+ "name": "Custom Role Manager",
+ "description": "Permissions to manage custom roles within an org",
+ "permissions": [
+ "write_organization_custom_repo_role",
+ "write_organization_custom_org_role",
+ "read_organization_custom_repo_role",
+ "read_organization_custom_org_role"
+ ],
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "created_at": "2022-07-04T22:19:11Z",
+ "updated_at": "2022-07-04T22:20:11Z"
+ }
+ },
+ "package-org": {
+ "value": {
+ "id": 197,
+ "name": "hello_docker",
+ "package_type": "container",
+ "owner": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "version_count": 1,
+ "visibility": "private",
+ "url": "https://api.github.com/orgs/github/packages/container/hello_docker",
+ "created_at": "2020-05-19T22:19:11Z",
+ "updated_at": "2020-05-19T22:19:11Z",
+ "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker"
+ }
+ },
+ "package-versions-for-org": {
+ "value": [
+ {
+ "id": 245301,
+ "name": "1.0.4",
+ "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301",
+ "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752",
+ "created_at": "2019-11-05T22:49:04Z",
+ "updated_at": "2019-11-05T22:49:04Z",
+ "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4",
+ "metadata": {
+ "package_type": "npm"
+ }
+ },
+ {
+ "id": 209672,
+ "name": "1.0.3",
+ "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672",
+ "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752",
+ "created_at": "2019-10-29T15:42:11Z",
+ "updated_at": "2019-10-29T15:42:12Z",
+ "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3",
+ "metadata": {
+ "package_type": "npm"
+ }
+ }
+ ]
+ },
+ "package-version-org": {
+ "value": {
+ "id": 836,
+ "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344",
+ "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836",
+ "package_html_url": "https://github.com/orgs/github/packages/container/package/hello_docker",
+ "created_at": "2020-05-19T22:19:11Z",
+ "updated_at": "2020-05-19T22:19:11Z",
+ "html_url": "https://github.com/orgs/github/packages/container/hello_docker/836",
+ "metadata": {
+ "package_type": "container",
+ "container": {
+ "tags": [
+ "latest"
+ ]
+ }
+ }
+ }
+ },
+ "org-pat-grant-request-paginated": {
+ "value": [
+ {
+ "id": 25381,
+ "reason": "I need to access the GitHub API",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories",
+ "permissions": {
+ "organization": {
+ "members": "read"
+ },
+ "repository": {
+ "metadata": "read"
+ }
+ },
+ "created_at": "2023-05-16T08:47:09.000-07:00",
+ "token_expired": false,
+ "token_expires_at": "2023-11-16T08:47:09.000-07:00",
+ "token_last_used_at": null
+ }
+ ]
+ },
+ "org-pat-grant-paginated": {
+ "value": [
+ {
+ "id": 25381,
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories",
+ "permissions": {
+ "organization": {
+ "members": "read"
+ },
+ "repository": {
+ "metadata": "read"
+ }
+ },
+ "access_granted_at": "2023-05-16T08:47:09.000-07:00",
+ "token_expired": false,
+ "token_expires_at": "2023-11-16T08:47:09.000-07:00",
+ "token_last_used_at": null
+ }
+ ]
+ },
+ "project-items": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": true
+ }
+ ]
+ },
+ "project-2": {
+ "value": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z"
+ }
+ },
+ "org-custom-properties": {
+ "value": [
+ {
+ "property_name": "environment",
+ "value_type": "single_select",
+ "required": true,
+ "default_value": "production",
+ "description": "Prod or dev environment",
+ "allowed_values": [
+ "production",
+ "development"
+ ],
+ "values_editable_by": "org_actors"
+ },
+ {
+ "property_name": "service",
+ "value_type": "string"
+ },
+ {
+ "property_name": "team",
+ "value_type": "string",
+ "description": "Team owning the repository"
+ }
+ ]
+ },
+ "org-custom-property": {
+ "value": {
+ "property_name": "environment",
+ "value_type": "single_select",
+ "required": true,
+ "default_value": "production",
+ "description": "Prod or dev environment",
+ "allowed_values": [
+ "production",
+ "development"
+ ]
+ }
+ },
+ "org-repo-custom-property-values": {
+ "value": [
+ {
+ "repository_id": 1296269,
+ "repository_name": "Hello-World",
+ "repository_full_name": "octocat/Hello-World",
+ "properties": [
+ {
+ "property_name": "environment",
+ "value": "production"
+ },
+ {
+ "property_name": "service",
+ "value": "web"
+ },
+ {
+ "property_name": "team",
+ "value": "octocat"
+ }
+ ]
+ }
+ ]
+ },
+ "org-repo-update-custom-property-values": {
+ "value": {
+ "repository_names": [
+ "Hello-World",
+ "octo-repo"
+ ],
+ "properties": [
+ {
+ "property_name": "environment",
+ "value": "production"
+ },
+ {
+ "property_name": "service",
+ "value": "web"
+ },
+ {
+ "property_name": "team",
+ "value": "octocat"
+ }
+ ]
+ }
+ },
+ "full-repository": {
+ "value": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "language": null,
+ "forks_count": 9,
+ "forks": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "open_issues": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "pull": true,
+ "push": false,
+ "admin": false
+ },
+ "allow_rebase_merge": true,
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "allow_forking": true,
+ "web_commit_signoff_required": false,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "organization": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "parent": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ },
+ "source": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ }
+ },
+ "org-ruleset-items": {
+ "value": [
+ {
+ "id": 21,
+ "name": "super cool ruleset",
+ "source_type": "Organization",
+ "source": "my-org",
+ "enforcement": "enabled",
+ "node_id": "RRS_lACkVXNlcgQB",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/orgs/my-org/rulesets/21"
+ },
+ "html": {
+ "href": "https://github.com/organizations/my-org/settings/rules/21"
+ }
+ },
+ "created_at": "2023-07-15T08:43:03Z",
+ "updated_at": "2023-08-23T16:29:47Z"
+ },
+ {
+ "id": 432,
+ "name": "Another ruleset",
+ "source_type": "Organization",
+ "source": "my-org",
+ "enforcement": "enabled",
+ "node_id": "RRS_lACkVXNlcgQQ",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/orgs/my-org/rulesets/432"
+ },
+ "html": {
+ "href": "https://github.com/organizations/my-org/settings/rules/432"
+ }
+ },
+ "created_at": "2023-08-15T08:43:03Z",
+ "updated_at": "2023-09-23T16:29:47Z"
+ }
+ ]
+ },
+ "org-ruleset": {
+ "value": {
+ "id": 21,
+ "name": "super cool ruleset",
+ "target": "branch",
+ "source_type": "Organization",
+ "source": "my-org",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ },
+ "repository_name": {
+ "include": [
+ "important_repository",
+ "another_important_repository"
+ ],
+ "exclude": [
+ "unimportant_repository"
+ ],
+ "protected": true
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ],
+ "node_id": "RRS_lACkVXNlcgQB",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/orgs/my-org/rulesets/21"
+ },
+ "html": {
+ "href": "https://github.com/organizations/my-org/settings/rules/21"
+ }
+ },
+ "created_at": "2023-08-15T08:43:03Z",
+ "updated_at": "2023-09-23T16:29:47Z"
+ }
+ },
+ "rule-suite-items": {
+ "value": [
+ {
+ "id": 21,
+ "actor_id": 12,
+ "username": "octocat",
+ "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
+ "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
+ "ref": "refs/heads/i-see-everything",
+ "repository_id": 404,
+ "repository_name": "octo-repo",
+ "pushed_at": "2023-07-06T08:43:03Z",
+ "result": "bypass"
+ },
+ {
+ "id": 25,
+ "actor_id": 11,
+ "username": "not-octocat",
+ "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc",
+ "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1",
+ "ref": "refs/heads/i-am-everything",
+ "repository_id": 404,
+ "repository_name": "octo-repo",
+ "pushed_at": "2023-07-07T08:43:03Z",
+ "result": "pass",
+ "evaluation_result": "fail"
+ }
+ ]
+ },
+ "rule-suite": {
+ "value": {
+ "id": 21,
+ "actor_id": 12,
+ "username": "octocat",
+ "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
+ "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
+ "ref": "refs/heads/i-see-everything",
+ "repository_id": 404,
+ "repository_name": "octo-repo",
+ "pushed_at": "2023-07-06T08:43:03Z",
+ "result": "bypass",
+ "evaluation_result": "fail",
+ "rule_evaluations": [
+ {
+ "rule_source": {
+ "type": "ruleset",
+ "id": 2,
+ "name": "Author email must be a GitHub email address"
+ },
+ "enforcement": "active",
+ "result": "pass",
+ "rule_type": "commit_author_email_pattern"
+ },
+ {
+ "rule_source": {
+ "type": "protected_branch"
+ },
+ "enforcement": "active",
+ "result": "fail",
+ "rule_type": "pull_request",
+ "details": "Changes must be made through a pull request."
+ },
+ {
+ "rule_source": {
+ "type": "ruleset",
+ "id": 3,
+ "name": "Evaluate commit message pattern"
+ },
+ "enforcement": "evaluate",
+ "result": "fail",
+ "rule_type": "commit_message_pattern"
+ }
+ ]
+ }
+ },
+ "list-repository-advisories": {
+ "value": [
+ {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "critical",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-01T00:00:00Z",
+ "updated_at": "2020-01-02T00:00:00Z",
+ "published_at": "2020-01-03T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
+ "score": 9.8
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-123",
+ "name": "A CWE"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ],
+ "credits": [
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ],
+ "private_fork": null
+ },
+ {
+ "ghsa_id": "GHSA-1234-5678-9012",
+ "cve_id": "CVE-2051-0000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "low",
+ "author": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "monalisa",
+ "id": 3,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-1234-5678-9012"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2051-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-03T00:00:00Z",
+ "updated_at": "2020-01-04T00:00:00Z",
+ "published_at": "2020-01-04T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": {
+ "accepted": true
+ },
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N",
+ "score": 1.6
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-456",
+ "name": "A CWE 2.0"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-456"
+ ],
+ "credits": [
+ {
+ "login": "monauser",
+ "type": "reporter"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "reporter",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ],
+ "private_fork": {
+ "id": 217723378,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+ "name": "octo-repo-ghsa-1234-5678-9012",
+ "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012",
+ "owner": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "private": true,
+ "html_url": "https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012",
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors",
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments",
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads",
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events",
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks",
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}",
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages",
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges",
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers",
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription",
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags",
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams",
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}"
+ }
+ }
+ ]
+ },
+ "actions-billing-usage": {
+ "value": {
+ "total_minutes_used": 305,
+ "total_paid_minutes_used": 0,
+ "included_minutes": 3000,
+ "minutes_used_breakdown": {
+ "UBUNTU": 205,
+ "MACOS": 10,
+ "WINDOWS": 90
+ }
+ }
+ },
+ "packages-billing-usage": {
+ "value": {
+ "total_gigabytes_bandwidth_used": 50,
+ "total_paid_gigabytes_bandwidth_used": 40,
+ "included_gigabytes_bandwidth": 10
+ }
+ },
+ "combined-billing-usage": {
+ "value": {
+ "days_left_in_billing_cycle": 20,
+ "estimated_paid_storage_for_month": 15,
+ "estimated_storage_for_month": 40
+ }
+ },
+ "team-full": {
+ "value": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null,
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "is_verified": true,
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ },
+ "team-discussion-items": {
+ "value": [
+ {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 0,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ ]
+ },
+ "team-discussion": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 0,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ },
+ "team-discussion-2": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 1,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": "2018-01-26T18:22:20Z",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
+ "updated_at": "2018-01-26T18:22:20Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ },
+ "team-discussion-comment-items": {
+ "value": [
+ {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like apples?",
+ "body_html": "Do you like apples?
",
+ "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": null,
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-15T23:53:58Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ ]
+ },
+ "team-discussion-comment": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like apples?",
+ "body_html": "Do you like apples?
",
+ "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": null,
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-15T23:53:58Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ },
+ "team-discussion-comment-2": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like pineapples?",
+ "body_html": "Do you like pineapples?
",
+ "body_version": "e6907b24d9c93cc0c5024a7af5888116",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": "2018-01-26T18:22:20Z",
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-26T18:22:20Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ },
+ "reaction-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDg6UmVhY3Rpb24x",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "content": "heart",
+ "created_at": "2016-05-20T20:09:31Z"
+ }
+ ]
+ },
+ "reaction": {
+ "value": {
+ "id": 1,
+ "node_id": "MDg6UmVhY3Rpb24x",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "content": "heart",
+ "created_at": "2016-05-20T20:09:31Z"
+ }
+ },
+ "team-membership-response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ },
+ "team-membership-response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
+ }
+ },
+ "team-project-items": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
+ }
+ }
+ ]
+ },
+ "team-project": {
+ "value": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
+ }
+ }
+ },
+ "team-repository-alternative-response-with-repository-permissions": {
+ "value": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "maintain": false,
+ "push": false,
+ "triage": false,
+ "pull": true
+ },
+ "role_name": "read",
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "team-items-response-if-child-teams-exist": {
+ "value": [
+ {
+ "id": 2,
+ "node_id": "MDQ6VGVhbTI=",
+ "url": "https://api.github.com/teams/2",
+ "name": "Original Roster",
+ "slug": "original-roster",
+ "description": "Started it all.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/2/members{/member}",
+ "repositories_url": "https://api.github.com/teams/2/repos",
+ "parent": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
+ },
+ "html_url": "https://github.com/orgs/rails/teams/core"
+ }
+ ]
+ },
+ "project-card": {
+ "value": {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
+ "archived": false,
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
+ }
+ },
+ "project-column": {
+ "value": {
+ "url": "https://api.github.com/projects/columns/367",
+ "project_url": "https://api.github.com/projects/120",
+ "cards_url": "https://api.github.com/projects/columns/367/cards",
+ "id": 367,
+ "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
+ "name": "To Do",
+ "created_at": "2016-09-05T14:18:44Z",
+ "updated_at": "2016-09-05T14:22:28Z"
+ }
+ },
+ "project-card-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
+ "archived": false,
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
+ }
+ ]
+ },
+ "project-3": {
+ "value": {
+ "owner_url": "https://api.github.com/repos/api-playground/projects-test",
+ "url": "https://api.github.com/projects/1002604",
+ "html_url": "https://github.com/api-playground/projects-test/projects/1",
+ "columns_url": "https://api.github.com/projects/1002604/columns",
+ "id": 1002604,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=",
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z"
+ }
+ },
+ "project-collaborator-permission": {
+ "value": {
+ "permission": "admin",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "project-column-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/projects/columns/367",
+ "project_url": "https://api.github.com/projects/120",
+ "cards_url": "https://api.github.com/projects/columns/367/cards",
+ "id": 367,
+ "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
+ "name": "To Do",
+ "created_at": "2016-09-05T14:18:44Z",
+ "updated_at": "2016-09-05T14:22:28Z"
+ }
+ ]
+ },
+ "rate-limit-overview": {
+ "value": {
+ "resources": {
+ "core": {
+ "limit": 5000,
+ "used": 1,
+ "remaining": 4999,
+ "reset": 1691591363
+ },
+ "search": {
+ "limit": 30,
+ "used": 12,
+ "remaining": 18,
+ "reset": 1691591091
+ },
+ "graphql": {
+ "limit": 5000,
+ "used": 7,
+ "remaining": 4993,
+ "reset": 1691593228
+ },
+ "integration_manifest": {
+ "limit": 5000,
+ "used": 1,
+ "remaining": 4999,
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
+ },
+ "code_scanning_upload": {
+ "limit": 500,
+ "used": 1,
+ "remaining": 499,
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
+ }
+ },
+ "rate": {
+ "limit": 5000,
+ "used": 1,
+ "remaining": 4999,
+ "reset": 1372700873
+ }
+ }
+ },
+ "full-repository-default-response": {
+ "summary": "Default response",
+ "value": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "forks_count": 9,
+ "forks": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "open_issues": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "pull": true,
+ "push": false,
+ "admin": false
+ },
+ "allow_rebase_merge": true,
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ "organization": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "parent": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ },
+ "source": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1,
+ "security_and_analysis": {
+ "advanced_security": {
+ "status": "enabled"
+ },
+ "secret_scanning": {
+ "status": "enabled"
+ },
+ "secret_scanning_push_protection": {
+ "status": "disabled"
+ }
+ }
+ }
+ }
+ },
+ "artifact-paginated": {
+ "value": {
+ "total_count": 2,
+ "artifacts": [
+ {
+ "id": 11,
+ "node_id": "MDg6QXJ0aWZhY3QxMQ==",
+ "name": "Rails",
+ "size_in_bytes": 556,
+ "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
+ "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
+ "expired": false,
+ "created_at": "2020-01-10T14:59:22Z",
+ "expires_at": "2020-03-21T14:59:22Z",
+ "updated_at": "2020-02-21T14:59:22Z",
+ "workflow_run": {
+ "id": 2332938,
+ "repository_id": 1296269,
+ "head_repository_id": 1296269,
+ "head_branch": "main",
+ "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3"
+ }
+ },
+ {
+ "id": 13,
+ "node_id": "MDg6QXJ0aWZhY3QxMw==",
+ "name": "Test output",
+ "size_in_bytes": 453,
+ "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13",
+ "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip",
+ "expired": false,
+ "created_at": "2020-01-10T14:59:22Z",
+ "expires_at": "2020-03-21T14:59:22Z",
+ "updated_at": "2020-02-21T14:59:22Z",
+ "workflow_run": {
+ "id": 2332942,
+ "repository_id": 1296269,
+ "head_repository_id": 1296269,
+ "head_branch": "main",
+ "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652"
+ }
+ }
+ ]
+ }
+ },
+ "artifact": {
+ "value": {
+ "id": 11,
+ "node_id": "MDg6QXJ0aWZhY3QxMQ==",
+ "name": "Rails",
+ "size_in_bytes": 556,
+ "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
+ "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
+ "expired": false,
+ "created_at": "2020-01-10T14:59:22Z",
+ "expires_at": "2020-01-21T14:59:22Z",
+ "updated_at": "2020-01-21T14:59:22Z",
+ "workflow_run": {
+ "id": 2332938,
+ "repository_id": 1296269,
+ "head_repository_id": 1296269,
+ "head_branch": "main",
+ "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3"
+ }
+ }
+ },
+ "actions-cache-usage": {
+ "value": {
+ "full_name": "octo-org/Hello-World",
+ "active_caches_size_in_bytes": 2322142,
+ "active_caches_count": 3
+ }
+ },
+ "actions-cache-list": {
+ "value": {
+ "total_count": 1,
+ "actions_caches": [
+ {
+ "id": 505,
+ "ref": "refs/heads/main",
+ "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
+ "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0",
+ "last_accessed_at": "2019-01-24T22:45:36.000Z",
+ "created_at": "2019-01-24T22:45:36.000Z",
+ "size_in_bytes": 1024
+ }
+ ]
+ }
+ },
+ "job": {
+ "value": {
+ "id": 399444496,
+ "run_id": 29679449,
+ "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
+ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
+ "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
+ "status": "completed",
+ "conclusion": "success",
+ "started_at": "2020-01-20T17:42:40Z",
+ "completed_at": "2020-01-20T17:44:39Z",
+ "name": "build",
+ "steps": [
+ {
+ "name": "Set up job",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 1,
+ "started_at": "2020-01-20T09:42:40.000-08:00",
+ "completed_at": "2020-01-20T09:42:41.000-08:00"
+ },
+ {
+ "name": "Run actions/checkout@v2",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 2,
+ "started_at": "2020-01-20T09:42:41.000-08:00",
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
+ },
+ {
+ "name": "Set up Ruby",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 3,
+ "started_at": "2020-01-20T09:42:45.000-08:00",
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
+ },
+ {
+ "name": "Run actions/cache@v3",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 4,
+ "started_at": "2020-01-20T09:42:45.000-08:00",
+ "completed_at": "2020-01-20T09:42:48.000-08:00"
+ },
+ {
+ "name": "Install Bundler",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 5,
+ "started_at": "2020-01-20T09:42:48.000-08:00",
+ "completed_at": "2020-01-20T09:42:52.000-08:00"
+ },
+ {
+ "name": "Install Gems",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 6,
+ "started_at": "2020-01-20T09:42:52.000-08:00",
+ "completed_at": "2020-01-20T09:42:53.000-08:00"
+ },
+ {
+ "name": "Run Tests",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 7,
+ "started_at": "2020-01-20T09:42:53.000-08:00",
+ "completed_at": "2020-01-20T09:42:59.000-08:00"
+ },
+ {
+ "name": "Deploy to Heroku",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 8,
+ "started_at": "2020-01-20T09:42:59.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ },
+ {
+ "name": "Post actions/cache@v3",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 16,
+ "started_at": "2020-01-20T09:44:39.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ },
+ {
+ "name": "Complete job",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 17,
+ "started_at": "2020-01-20T09:44:39.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ }
+ ],
+ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
+ "labels": [
+ "self-hosted",
+ "foo",
+ "bar"
+ ],
+ "runner_id": 1,
+ "runner_name": "my runner",
+ "runner_group_id": 2,
+ "runner_group_name": "my runner group",
+ "workflow_name": "CI",
+ "head_branch": "main"
+ }
+ },
+ "oidc-custom-sub-repo": {
+ "value": {
+ "use_default": false,
+ "include_claim_keys": [
+ "repo",
+ "context"
+ ]
+ }
+ },
+ "actions-secret-paginated": {
+ "value": {
+ "total_count": 2,
+ "secrets": [
+ {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z"
+ },
+ {
+ "name": "GIST_ID",
+ "created_at": "2020-01-10T10:59:22Z",
+ "updated_at": "2020-01-11T11:59:22Z"
+ }
+ ]
+ }
+ },
+ "actions-variables-paginated": {
+ "value": {
+ "total_count": 2,
+ "variables": [
+ {
+ "name": "USERNAME",
+ "value": "octocat",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z"
+ },
+ {
+ "name": "EMAIL",
+ "value": "octocat@github.com",
+ "created_at": "2020-01-10T10:59:22Z",
+ "updated_at": "2020-01-11T11:59:22Z"
+ }
+ ]
+ }
+ },
+ "actions-repository-permissions": {
+ "value": {
+ "enabled": true,
+ "allowed_actions": "selected",
+ "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions"
+ }
+ },
+ "actions-workflow-access-to-repository": {
+ "value": {
+ "access_level": "organization"
+ }
+ },
+ "workflow-run-paginated": {
+ "value": {
+ "total_count": 1,
+ "workflow_runs": [
+ {
+ "id": 30433642,
+ "name": "Build",
+ "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
+ "check_suite_id": 42,
+ "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
+ "head_branch": "master",
+ "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
+ "path": ".github/workflows/build.yml@main",
+ "run_number": 562,
+ "event": "push",
+ "display_title": "Update README.md",
+ "status": "queued",
+ "conclusion": null,
+ "workflow_id": 159038,
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
+ "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
+ "pull_requests": [
+
+ ],
+ "created_at": "2020-01-22T19:33:08Z",
+ "updated_at": "2020-01-22T19:33:08Z",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "run_attempt": 1,
+ "run_started_at": "2020-01-22T19:33:08Z",
+ "triggering_actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
+ "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
+ "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
+ "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
+ "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
+ "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
+ "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
+ "head_commit": {
+ "id": "acb5820ced9479c074f688cc328bf03f341a511d",
+ "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
+ "message": "Create linter.yaml",
+ "timestamp": "2020-01-22T19:33:05Z",
+ "author": {
+ "name": "Octo Cat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "name": "GitHub",
+ "email": "noreply@github.com"
+ }
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "head_repository": {
+ "id": 217723378,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+ "name": "octo-repo",
+ "full_name": "octo-org/octo-repo",
+ "private": true,
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/octo-org/octo-repo",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/octo-repo",
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
+ }
+ }
+ ]
+ }
+ },
+ "workflow-run": {
+ "value": {
+ "id": 30433642,
+ "name": "Build",
+ "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
+ "check_suite_id": 42,
+ "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
+ "head_branch": "main",
+ "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
+ "path": ".github/workflows/build.yml@main",
+ "run_number": 562,
+ "event": "push",
+ "display_title": "Update README.md",
+ "status": "queued",
+ "conclusion": null,
+ "workflow_id": 159038,
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
+ "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
+ "pull_requests": [
+
+ ],
+ "created_at": "2020-01-22T19:33:08Z",
+ "updated_at": "2020-01-22T19:33:08Z",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "run_attempt": 1,
+ "referenced_workflows": [
+ {
+ "path": "octocat/Hello-World/.github/workflows/deploy.yml@main",
+ "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db",
+ "ref": "refs/heads/main"
+ },
+ {
+ "path": "octo-org/octo-repo/.github/workflows/report.yml@v2",
+ "sha": "79e9790903e1c3373b1a3e3a941d57405478a232",
+ "ref": "refs/tags/v2"
+ },
+ {
+ "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e",
+ "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e"
+ }
+ ],
+ "run_started_at": "2020-01-22T19:33:08Z",
+ "triggering_actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
+ "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
+ "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
+ "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
+ "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
+ "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
+ "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1",
+ "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
+ "head_commit": {
+ "id": "acb5820ced9479c074f688cc328bf03f341a511d",
+ "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
+ "message": "Create linter.yaml",
+ "timestamp": "2020-01-22T19:33:05Z",
+ "author": {
+ "name": "Octo Cat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "name": "GitHub",
+ "email": "noreply@github.com"
+ }
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "head_repository": {
+ "id": 217723378,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+ "name": "octo-repo",
+ "full_name": "octo-org/octo-repo",
+ "private": true,
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/octo-org/octo-repo",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/octo-repo",
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
+ }
+ }
+ },
+ "environment-approvals-items": {
+ "value": [
+ {
+ "state": "approved",
+ "comment": "Ship it!",
+ "environments": [
+ {
+ "id": 161088068,
+ "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
+ "name": "staging",
+ "url": "https://api.github.com/repos/github/hello-world/environments/staging",
+ "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
+ "created_at": "2020-11-23T22:00:40Z",
+ "updated_at": "2020-11-23T22:00:40Z"
+ }
+ ],
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "job-paginated": {
+ "value": {
+ "total_count": 1,
+ "jobs": [
+ {
+ "id": 399444496,
+ "run_id": 29679449,
+ "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
+ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
+ "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
+ "status": "completed",
+ "conclusion": "success",
+ "started_at": "2020-01-20T17:42:40Z",
+ "completed_at": "2020-01-20T17:44:39Z",
+ "name": "build",
+ "steps": [
+ {
+ "name": "Set up job",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 1,
+ "started_at": "2020-01-20T09:42:40.000-08:00",
+ "completed_at": "2020-01-20T09:42:41.000-08:00"
+ },
+ {
+ "name": "Run actions/checkout@v2",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 2,
+ "started_at": "2020-01-20T09:42:41.000-08:00",
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
+ },
+ {
+ "name": "Set up Ruby",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 3,
+ "started_at": "2020-01-20T09:42:45.000-08:00",
+ "completed_at": "2020-01-20T09:42:45.000-08:00"
+ },
+ {
+ "name": "Run actions/cache@v3",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 4,
+ "started_at": "2020-01-20T09:42:45.000-08:00",
+ "completed_at": "2020-01-20T09:42:48.000-08:00"
+ },
+ {
+ "name": "Install Bundler",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 5,
+ "started_at": "2020-01-20T09:42:48.000-08:00",
+ "completed_at": "2020-01-20T09:42:52.000-08:00"
+ },
+ {
+ "name": "Install Gems",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 6,
+ "started_at": "2020-01-20T09:42:52.000-08:00",
+ "completed_at": "2020-01-20T09:42:53.000-08:00"
+ },
+ {
+ "name": "Run Tests",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 7,
+ "started_at": "2020-01-20T09:42:53.000-08:00",
+ "completed_at": "2020-01-20T09:42:59.000-08:00"
+ },
+ {
+ "name": "Deploy to Heroku",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 8,
+ "started_at": "2020-01-20T09:42:59.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ },
+ {
+ "name": "Post actions/cache@v3",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 16,
+ "started_at": "2020-01-20T09:44:39.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ },
+ {
+ "name": "Complete job",
+ "status": "completed",
+ "conclusion": "success",
+ "number": 17,
+ "started_at": "2020-01-20T09:44:39.000-08:00",
+ "completed_at": "2020-01-20T09:44:39.000-08:00"
+ }
+ ],
+ "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
+ "labels": [
+ "self-hosted",
+ "foo",
+ "bar"
+ ],
+ "runner_id": 1,
+ "runner_name": "my runner",
+ "runner_group_id": 2,
+ "runner_group_name": "my runner group",
+ "workflow_name": "CI",
+ "head_branch": "main"
+ }
+ ]
+ }
+ },
+ "pending-deployment-items": {
+ "value": [
+ {
+ "environment": {
+ "id": 161088068,
+ "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
+ "name": "staging",
+ "url": "https://api.github.com/repos/github/hello-world/environments/staging",
+ "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
+ },
+ "wait_timer": 30,
+ "wait_timer_started_at": "2020-11-23T22:00:40Z",
+ "current_user_can_approve": true,
+ "reviewers": [
+ {
+ "type": "User",
+ "reviewer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ },
+ {
+ "type": "Team",
+ "reviewer": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "deployment-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/example/deployments/1",
+ "id": 1,
+ "node_id": "MDEwOkRlcGxveW1lbnQx",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "ref": "topic-branch",
+ "task": "deploy",
+ "payload": {
+ },
+ "original_environment": "staging",
+ "environment": "production",
+ "description": "Deploy request from hubot",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
+ "repository_url": "https://api.github.com/repos/octocat/example",
+ "transient_environment": false,
+ "production_environment": true
+ }
+ ]
+ },
+ "workflow-run-usage": {
+ "value": {
+ "billable": {
+ "UBUNTU": {
+ "total_ms": 180000,
+ "jobs": 1,
+ "job_runs": [
+ {
+ "job_id": 1,
+ "duration_ms": 180000
+ }
+ ]
+ },
+ "MACOS": {
+ "total_ms": 240000,
+ "jobs": 4,
+ "job_runs": [
+ {
+ "job_id": 2,
+ "duration_ms": 60000
+ },
+ {
+ "job_id": 3,
+ "duration_ms": 60000
+ },
+ {
+ "job_id": 4,
+ "duration_ms": 60000
+ },
+ {
+ "job_id": 5,
+ "duration_ms": 60000
+ }
+ ]
+ },
+ "WINDOWS": {
+ "total_ms": 300000,
+ "jobs": 2,
+ "job_runs": [
+ {
+ "job_id": 6,
+ "duration_ms": 150000
+ },
+ {
+ "job_id": 7,
+ "duration_ms": 150000
+ }
+ ]
+ }
+ },
+ "run_duration_ms": 500000
+ }
+ },
+ "actions-secret": {
+ "value": {
+ "name": "GH_TOKEN",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z"
+ }
+ },
+ "actions-variable": {
+ "value": {
+ "name": "USERNAME",
+ "value": "octocat",
+ "created_at": "2021-08-10T14:59:22Z",
+ "updated_at": "2022-01-10T14:59:22Z"
+ }
+ },
+ "workflow-paginated": {
+ "value": {
+ "total_count": 2,
+ "workflows": [
+ {
+ "id": 161335,
+ "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
+ "name": "CI",
+ "path": ".github/workflows/blank.yaml",
+ "state": "active",
+ "created_at": "2020-01-08T23:48:37.000-08:00",
+ "updated_at": "2020-01-08T23:50:21.000-08:00",
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
+ "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
+ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
+ },
+ {
+ "id": 269289,
+ "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==",
+ "name": "Linter",
+ "path": ".github/workflows/linter.yaml",
+ "state": "active",
+ "created_at": "2020-01-08T23:48:37.000-08:00",
+ "updated_at": "2020-01-08T23:50:21.000-08:00",
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289",
+ "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289",
+ "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg"
+ }
+ ]
+ }
+ },
+ "workflow": {
+ "value": {
+ "id": 161335,
+ "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
+ "name": "CI",
+ "path": ".github/workflows/blank.yaml",
+ "state": "active",
+ "created_at": "2020-01-08T23:48:37.000-08:00",
+ "updated_at": "2020-01-08T23:50:21.000-08:00",
+ "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
+ "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
+ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
+ }
+ },
+ "workflow-usage": {
+ "value": {
+ "billable": {
+ "UBUNTU": {
+ "total_ms": 180000
+ },
+ "MACOS": {
+ "total_ms": 240000
+ },
+ "WINDOWS": {
+ "total_ms": 300000
+ }
+ }
+ }
+ },
+ "activity-items": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "after": "827efc6d56897b048c772eb4087f854f46256132",
+ "ref": "refs/heads/main",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "push_type": "normal",
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "autolink-items": {
+ "value": [
+ {
+ "id": 1,
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query=",
+ "is_alphanumeric": true
+ }
+ ]
+ },
+ "autolink": {
+ "value": {
+ "id": 1,
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query=",
+ "is_alphanumeric": true
+ }
+ },
+ "short-branch-with-protection-items": {
+ "value": [
+ {
+ "name": "master",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "protected": true,
+ "protection": {
+ "required_status_checks": {
+ "enforcement_level": "non_admins",
+ "contexts": [
+ "ci-test",
+ "linter"
+ ]
+ }
+ },
+ "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection"
+ }
+ ]
+ },
+ "branch-get": {
+ "value": {
+ "name": "main",
+ "commit": {
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
+ "commit": {
+ "author": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com",
+ "date": "2012-03-06T23:06:50Z"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com",
+ "date": "2012-03-06T23:06:50Z"
+ },
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "tree": {
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+ },
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "comment_count": 77,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
+ "author": {
+ "login": "octocat",
+ "id": 583231,
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 583231,
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+ },
+ {
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
+ }
+ ]
+ },
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
+ "html": "https://github.com/octocat/Hello-World/tree/main"
+ },
+ "protected": false,
+ "protection": {
+ "enabled": false,
+ "required_status_checks": {
+ "enforcement_level": "off",
+ "contexts": [
+
+ ],
+ "checks": [
+
+ ]
+ }
+ },
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
+ }
+ },
+ "branch-protection": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
+ "required_status_checks": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks",
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ],
+ "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts",
+ "enforcement_level": "non_admins"
+ },
+ "enforce_admins": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
+ "enabled": true
+ },
+ "required_pull_request_reviews": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews",
+ "dismissal_restrictions": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions",
+ "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams",
+ "users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "apps": [
+ {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2,
+ "require_last_push_approval": true
+ },
+ "restrictions": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions",
+ "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams",
+ "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps",
+ "users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "apps": [
+ {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ ]
+ },
+ "required_linear_history": {
+ "enabled": true
+ },
+ "allow_force_pushes": {
+ "enabled": true
+ },
+ "allow_deletions": {
+ "enabled": true
+ },
+ "required_conversation_resolution": {
+ "enabled": true
+ },
+ "lock_branch": {
+ "enabled": true
+ },
+ "allow_fork_syncing": {
+ "enabled": true
+ }
+ }
+ },
+ "branch-protection-update": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
+ "required_status_checks": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ],
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
+ "checks": [
+ {
+ "context": "continuous-integration/travis-ci",
+ "app_id": null
+ }
+ ]
+ },
+ "restrictions": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
+ "users": [
+
+ ],
+ "teams": [
+
+ ],
+ "apps": [
+
+ ]
+ },
+ "required_pull_request_reviews": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2,
+ "require_last_push_approval": true,
+ "dismissal_restrictions": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
+ "users": [
+
+ ],
+ "teams": [
+
+ ],
+ "apps": [
+
+ ]
+ }
+ },
+ "required_signatures": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
+ "enabled": false
+ },
+ "enforce_admins": {
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
+ "enabled": true
+ },
+ "required_linear_history": {
+ "enabled": true
+ },
+ "allow_force_pushes": {
+ "enabled": true
+ },
+ "allow_deletions": {
+ "enabled": true
+ },
+ "block_creations": {
+ "enabled": true
+ },
+ "required_conversation_resolution": {
+ "enabled": true
+ },
+ "lock_branch": {
+ "enabled": true
+ },
+ "allow_fork_syncing": {
+ "enabled": true
+ }
+ }
+ },
+ "protected-branch-admin-enforced-2": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
+ "enabled": true
+ }
+ },
+ "protected-branch-pull-request-review": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews",
+ "dismissal_restrictions": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions",
+ "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams",
+ "users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "apps": [
+ {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2,
+ "require_last_push_approval": true
+ }
+ },
+ "protected-branch-admin-enforced": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures",
+ "enabled": true
+ }
+ },
+ "status-check-policy": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks",
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ],
+ "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts"
+ }
+ },
+ "branch-restriction-policy": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions",
+ "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams",
+ "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps",
+ "users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "apps": [
+ {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ ]
+ }
+ },
+ "integration-items": {
+ "value": [
+ {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ }
+ ]
+ },
+ "branch-with-protection": {
+ "value": {
+ "name": "master",
+ "commit": {
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==",
+ "commit": {
+ "author": {
+ "name": "The Octocat",
+ "date": "2012-03-06T15:06:50-08:00",
+ "email": "octocat@nowhere.com"
+ },
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "tree": {
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "date": "2012-03-06T15:06:50-08:00",
+ "email": "octocat@nowhere.com"
+ },
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ },
+ "comment_count": 0
+ },
+ "author": {
+ "gravatar_id": "",
+ "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+ "url": "https://api.github.com/users/octocat",
+ "id": 583231,
+ "login": "octocat",
+ "node_id": "MDQ6VXNlcjE=",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "parents": [
+ {
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+ },
+ {
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303"
+ }
+ ],
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "committer": {
+ "gravatar_id": "",
+ "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+ "url": "https://api.github.com/users/octocat",
+ "id": 583231,
+ "login": "octocat",
+ "node_id": "MDQ6VXNlcjE=",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments"
+ },
+ "_links": {
+ "html": "https://github.com/octocat/Hello-World/tree/master",
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/master"
+ },
+ "protected": true,
+ "protection": {
+ "required_status_checks": {
+ "enforcement_level": "non_admins",
+ "contexts": [
+ "ci-test",
+ "linter"
+ ]
+ }
+ },
+ "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection"
+ }
+ },
+ "check-run-example-of-completed-conclusion": {
+ "summary": "Response for completed conclusion",
+ "value": {
+ "id": 4,
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "node_id": "MDg6Q2hlY2tSdW40",
+ "external_id": "42",
+ "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
+ "html_url": "https://github.com/github/hello-world/runs/4",
+ "details_url": "https://example.com",
+ "status": "completed",
+ "conclusion": "neutral",
+ "started_at": "2018-05-04T01:14:52Z",
+ "completed_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notice.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations_count": 2,
+ "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
+ },
+ "name": "mighty_readme",
+ "check_suite": {
+ "id": 5
+ },
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/github/hello-world/pulls/1",
+ "id": 1934,
+ "number": 3956,
+ "head": {
+ "ref": "say-hello",
+ "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "check-run-example-of-in-progress-conclusion": {
+ "summary": "Response for in_progress conclusion",
+ "value": {
+ "id": 4,
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "node_id": "MDg6Q2hlY2tSdW40",
+ "external_id": "42",
+ "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
+ "html_url": "https://github.com/github/hello-world/runs/4",
+ "details_url": "https://example.com",
+ "status": "in_progress",
+ "conclusion": null,
+ "started_at": "2018-05-04T01:14:52Z",
+ "completed_at": null,
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notice.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations_count": 2,
+ "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
+ },
+ "name": "mighty_readme",
+ "check_suite": {
+ "id": 5
+ },
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/github/hello-world/pulls/1",
+ "id": 1934,
+ "number": 3956,
+ "head": {
+ "ref": "say-hello",
+ "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "check-run": {
+ "value": {
+ "id": 4,
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "node_id": "MDg6Q2hlY2tSdW40",
+ "external_id": "",
+ "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
+ "html_url": "https://github.com/github/hello-world/runs/4",
+ "details_url": "https://example.com",
+ "status": "completed",
+ "conclusion": "neutral",
+ "started_at": "2018-05-04T01:14:52Z",
+ "completed_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notice.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations_count": 2,
+ "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
+ },
+ "name": "mighty_readme",
+ "check_suite": {
+ "id": 5
+ },
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/github/hello-world/pulls/1",
+ "id": 1934,
+ "number": 3956,
+ "head": {
+ "ref": "say-hello",
+ "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "check-annotation-items": {
+ "value": [
+ {
+ "path": "README.md",
+ "start_line": 2,
+ "end_line": 2,
+ "start_column": 5,
+ "end_column": 10,
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'banaas'.",
+ "raw_details": "Do you mean 'bananas' or 'banana'?",
+ "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc"
+ }
+ ]
+ },
+ "check-suite": {
+ "value": {
+ "id": 5,
+ "node_id": "MDEwOkNoZWNrU3VpdGU1",
+ "head_branch": "master",
+ "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "status": "completed",
+ "conclusion": "neutral",
+ "url": "https://api.github.com/repos/github/hello-world/check-suites/5",
+ "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
+ "after": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "pull_requests": [
+
+ ],
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "delete_branch_on_merge": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "head_commit": {
+ "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "timestamp": "2016-10-10T00:00:00Z",
+ "author": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ }
+ },
+ "latest_check_runs_count": 1,
+ "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs"
+ }
+ },
+ "check-suite-preference": {
+ "value": {
+ "preferences": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 2,
+ "setting": true
+ },
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ }
+ }
+ }
+ },
+ "check-run-paginated": {
+ "value": {
+ "total_count": 1,
+ "check_runs": [
+ {
+ "id": 4,
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "node_id": "MDg6Q2hlY2tSdW40",
+ "external_id": "",
+ "url": "https://api.github.com/repos/github/hello-world/check-runs/4",
+ "html_url": "https://github.com/github/hello-world/runs/4",
+ "details_url": "https://example.com",
+ "status": "completed",
+ "conclusion": "neutral",
+ "started_at": "2018-05-04T01:14:52Z",
+ "completed_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notice.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations_count": 2,
+ "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
+ },
+ "name": "mighty_readme",
+ "check_suite": {
+ "id": 5
+ },
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/github/hello-world/pulls/1",
+ "id": 1934,
+ "number": 3956,
+ "head": {
+ "ref": "say-hello",
+ "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "code-scanning-alert-items": {
+ "value": [
+ {
+ "number": 4,
+ "created_at": "2020-02-13T12:29:18Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/4",
+ "state": "open",
+ "fixed_at": null,
+ "dismissed_by": null,
+ "dismissed_at": null,
+ "dismissed_reason": null,
+ "dismissed_comment": null,
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "description": "Arbitrary file write during zip extraction",
+ "name": "js/zipslip"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "open",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "spec-main/api-session-spec.ts",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+ "test"
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances"
+ },
+ {
+ "number": 3,
+ "created_at": "2020-02-13T12:29:18Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/3",
+ "state": "dismissed",
+ "fixed_at": null,
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_at": "2020-02-14T12:29:18Z",
+ "dismissed_reason": "false positive",
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "description": "Arbitrary file write during zip extraction",
+ "name": "js/zipslip"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "open",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "lib/ab12-gen.js",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances"
+ }
+ ]
+ },
+ "code-scanning-alert": {
+ "value": {
+ "number": 42,
+ "created_at": "2020-06-19T11:21:34Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/42",
+ "state": "dismissed",
+ "fixed_at": null,
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 54933897,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_at": "2020-02-14T12:29:18Z",
+ "dismissed_reason": "false positive",
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "security_severity_level": "high",
+ "description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
+ "name": "js/zipslip",
+ "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
+ "help_uri": "https://codeql.github.com/"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "dismissed",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "spec-main/api-session-spec.ts",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+ "test"
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
+ }
+ },
+ "code-scanning-alert-dismissed": {
+ "value": {
+ "number": 42,
+ "created_at": "2020-08-25T21:28:36Z",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
+ "html_url": "https://github.com/octocat/hello-world/code-scanning/42",
+ "state": "dismissed",
+ "fixed_at": null,
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_at": "2020-09-02T22:34:56Z",
+ "dismissed_reason": "false positive",
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
+ "rule": {
+ "id": "js/zipslip",
+ "severity": "error",
+ "security_severity_level": "high",
+ "description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
+ "name": "js/zipslip",
+ "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
+ "tags": [
+ "security",
+ "external/cwe/cwe-022"
+ ],
+ "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
+ "help_uri": "https://codeql.github.com/"
+ },
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "most_recent_instance": {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "{}",
+ "state": "dismissed",
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "spec-main/api-session-spec.ts",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+ "test"
+ ]
+ },
+ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
+ }
+ },
+ "code-scanning-alert-instances": {
+ "value": [
+ {
+ "ref": "refs/heads/main",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "state": "open",
+ "fixed_at": null,
+ "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
+ "message": {
+ "text": "This path depends on a user-provided value."
+ },
+ "location": {
+ "path": "lib/ab12-gen.js",
+ "start_line": 917,
+ "end_line": 917,
+ "start_column": 7,
+ "end_column": 18
+ },
+ "classifications": [
+ "library"
+ ]
+ },
+ {
+ "ref": "refs/pull/3740/merge",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "environment": "",
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
+ "state": "fixed",
+ "fixed_at": "2020-02-14T12:29:18Z",
+ "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2",
+ "message": {
+ "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1."
+ },
+ "location": {
+ "path": "app/script.js",
+ "start_line": 2,
+ "end_line": 2,
+ "start_column": 10,
+ "end_column": 50
+ },
+ "classifications": [
+ "source"
+ ]
+ }
+ ]
+ },
+ "code-scanning-analysis-items": {
+ "value": [
+ {
+ "ref": "refs/heads/main",
+ "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
+ "environment": "{\"language\":\"python\"}",
+ "error": "",
+ "category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
+ "created_at": "2020-08-27T15:05:21Z",
+ "results_count": 17,
+ "rules_count": 49,
+ "id": 201,
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
+ "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "deletable": true,
+ "warning": ""
+ },
+ {
+ "ref": "refs/heads/my-branch",
+ "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321",
+ "analysis_key": ".github/workflows/shiftleft.yml:build",
+ "environment": "{}",
+ "error": "",
+ "category": ".github/workflows/shiftleft.yml:build/",
+ "created_at": "2020-08-31T22:46:44Z",
+ "results_count": 17,
+ "rules_count": 32,
+ "id": 200,
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200",
+ "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582",
+ "tool": {
+ "name": "Python Security Analysis",
+ "guid": null,
+ "version": "1.2.0"
+ },
+ "deletable": true,
+ "warning": ""
+ }
+ ]
+ },
+ "code-scanning-analysis-default": {
+ "summary": "application/json response",
+ "value": {
+ "ref": "refs/heads/main",
+ "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
+ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
+ "environment": "{\"language\":\"javascript\"}",
+ "error": "",
+ "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript",
+ "created_at": "2021-01-13T11:55:49Z",
+ "results_count": 3,
+ "rules_count": 67,
+ "id": 3602840,
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
+ "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
+ "tool": {
+ "name": "CodeQL",
+ "guid": null,
+ "version": "2.4.0"
+ },
+ "deletable": true,
+ "warning": ""
+ }
+ },
+ "code-scanning-analysis-sarif": {
+ "summary": "application/json+sarif response",
+ "value": {
+ "runs": [
+ {
+ "tool": {
+ "driver": {
+ "name": "CodeQL",
+ "organization": "GitHub",
+ "semanticVersion": "1.0.0",
+ "rules": [
+ {
+ "id": "js/unused-local-variable",
+ "name": "js/unused-local-variable"
+ }
+ ]
+ }
+ },
+ "results": [
+ {
+ "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
+ "message": {
+ "text": "Unused variable foo."
+ },
+ "locations": [
+ {
+ "physicalLocation": {
+ "artifactLocation": {
+ "uri": "file1.js"
+ },
+ "region": {
+ "startLine": 1
+ }
+ }
+ }
+ ],
+ "ruleId": "js/unused-local-variable",
+ "properties": [
+ {
+ "github/alertNumber": 2
+ },
+ {
+ "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "code-scanning-analysis-deletion": {
+ "summary": "Default response",
+ "value": {
+ "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41",
+ "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete"
+ }
+ },
+ "code-scanning-codeql-databases": {
+ "value": [
+ {
+ "id": 1,
+ "name": "database.zip",
+ "language": "java",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "content_type": "application/zip",
+ "size": 1024,
+ "created_at": "2022-09-12T12:14:32Z",
+ "updated_at": "2022-09-12T12:14:32Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
+ },
+ {
+ "id": 2,
+ "name": "database.zip",
+ "language": "ruby",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "content_type": "application/zip",
+ "size": 1024,
+ "created_at": "2022-09-12T12:14:32Z",
+ "updated_at": "2022-09-12T12:14:32Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby",
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
+ }
+ ]
+ },
+ "code-scanning-codeql-database": {
+ "value": {
+ "id": 1,
+ "name": "database.zip",
+ "language": "java",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "content_type": "application/zip",
+ "size": 1024,
+ "created_at": "2022-09-12T12:14:32Z",
+ "updated_at": "2022-09-12T12:14:32Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
+ }
+ },
+ "code-scanning-default-setup": {
+ "value": {
+ "state": "configured",
+ "languages": [
+ "ruby",
+ "python"
+ ],
+ "query_suite": "default",
+ "updated_at": "2023-01-19T11:21:34Z",
+ "schedule": "weekly"
+ }
+ },
+ "code-scanning-default-setup-update": {
+ "value": {
+ "state": "configured"
+ }
+ },
+ "code-scanning-default-setup-update-response": {
+ "value": {
+ "run_id": 42,
+ "run_url": "https://api.github.com/repos/octoorg/octocat/actions/runs/42"
+ }
+ },
+ "code-scanning-sarif-upload": {
+ "summary": "Default response",
+ "value": {
+ "id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
+ "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6"
+ }
+ },
+ "code-scanning-sarif-upload-status": {
+ "summary": "Default response",
+ "value": {
+ "processing_status": "complete",
+ "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6"
+ }
+ },
+ "codeowners-errors": {
+ "value": {
+ "errors": [
+ {
+ "line": 3,
+ "column": 1,
+ "kind": "Invalid pattern",
+ "source": "***/*.rb @monalisa",
+ "suggestion": "Did you mean `**/*.rb`?",
+ "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^",
+ "path": ".github/CODEOWNERS"
+ },
+ {
+ "line": 7,
+ "column": 7,
+ "kind": "Invalid owner",
+ "source": "*.txt docs@",
+ "suggestion": null,
+ "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^",
+ "path": ".github/CODEOWNERS"
+ }
+ ]
+ }
+ },
+ "codespaces-list-for-repository": {
+ "value": {
+ "total_count": 2,
+ "codespaces": [
+ {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-g4wpq6h95q",
+ "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
+ "recent_folders": [
+
+ ]
+ },
+ {
+ "id": 2,
+ "name": "monalisa-octocat-hello-world-3f89ada1j3",
+ "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop",
+ "recent_folders": [
+
+ ]
+ }
+ ]
+ }
+ },
+ "codespaces-list-devcontainers-for-repository": {
+ "value": {
+ "devcontainers": [
+ {
+ "path": ".devcontainer/foobar/devcontainer.json",
+ "name": "foobar",
+ "display_name": "foobar"
+ },
+ {
+ "path": ".devcontainer/devcontainer.json",
+ "name": "kitchensink",
+ "display_name": "kitchensink"
+ },
+ {
+ "path": ".devcontainer.json",
+ "display_name": "Default project configuration"
+ }
+ ],
+ "total_count": 3
+ }
+ },
+ "codespace-machines-list": {
+ "value": {
+ "total_count": 2,
+ "machines": [
+ {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ {
+ "name": "premiumLinux",
+ "display_name": "8 cores, 32 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 34359738368,
+ "cpus": 8
+ }
+ ]
+ }
+ },
+ "codespaces-default-attributes-for-a-codespace": {
+ "value": {
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "defaults": {
+ "location": "EastUs",
+ "devcontainer_path": ".devcontainer/devcontainer.json"
+ }
+ }
+ },
+ "codespaces-permissions-check-for-devcontainer": {
+ "value": {
+ "accepted": true
+ }
+ },
+ "collaborator-items": {
+ "value": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "permissions": {
+ "pull": true,
+ "triage": true,
+ "push": true,
+ "maintain": false,
+ "admin": false
+ },
+ "role_name": "write"
+ }
+ ]
+ },
+ "repository-invitation-response-when-a-new-invitation-is-created": {
+ "value": {
+ "id": 1,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "invitee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "inviter": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "permissions": "write",
+ "created_at": "2016-06-13T14:52:50-05:00",
+ "url": "https://api.github.com/user/repository_invitations/1296269",
+ "html_url": "https://github.com/octocat/Hello-World/invitations"
+ }
+ },
+ "repository-collaborator-permission-response-if-user-has-admin-permissions": {
+ "value": {
+ "permission": "admin",
+ "role_name": "admin",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "commit-comment-items": {
+ "value": [
+ {
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
+ "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
+ "id": 1,
+ "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 14,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "author_association": "COLLABORATOR"
+ }
+ ]
+ },
+ "commit-comment": {
+ "value": {
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
+ "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
+ "id": 1,
+ "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 14,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author_association": "COLLABORATOR",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z"
+ }
+ },
+ "commit-comment-2": {
+ "value": {
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
+ "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
+ "id": 1,
+ "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
+ "body": "Nice change",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 14,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author_association": "COLLABORATOR",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z"
+ }
+ },
+ "commit-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ }
+ ]
+ },
+ "branch-short-items": {
+ "value": [
+ {
+ "name": "branch_5",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "protected": false
+ }
+ ]
+ },
+ "pull-request-simple-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "id": 1,
+ "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
+ "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
+ "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "number": 1347,
+ "state": "open",
+ "locked": true,
+ "title": "Amazing new feature",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Please pull these awesome changes in!",
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "active_lock_reason": "too heated",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:01:12Z",
+ "closed_at": "2011-01-26T19:01:12Z",
+ "merged_at": "2011-01-26T19:01:12Z",
+ "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ }
+ ],
+ "requested_reviewers": [
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "requested_teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "permission": "admin",
+ "notification_setting": "notifications_enabled",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "issue": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "review_comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "commits": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "statuses": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ },
+ "author_association": "OWNER",
+ "auto_merge": null,
+ "draft": false
+ }
+ ]
+ },
+ "commit": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ],
+ "stats": {
+ "additions": 104,
+ "deletions": 4,
+ "total": 108
+ },
+ "files": [
+ {
+ "filename": "file1.txt",
+ "additions": 10,
+ "deletions": 2,
+ "changes": 12,
+ "status": "modified",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "patch": "@@ -29,7 +29,7 @@\n....."
+ }
+ ]
+ }
+ },
+ "check-suite-paginated": {
+ "value": {
+ "total_count": 1,
+ "check_suites": [
+ {
+ "id": 5,
+ "node_id": "MDEwOkNoZWNrU3VpdGU1",
+ "head_branch": "master",
+ "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "status": "completed",
+ "conclusion": "neutral",
+ "url": "https://api.github.com/repos/github/hello-world/check-suites/5",
+ "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
+ "after": "d6fde92930d4715a2b49857d24b940956b26d2d3",
+ "pull_requests": [
+
+ ],
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "delete_branch_on_merge": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "head_commit": {
+ "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "timestamp": "2016-10-10T00:00:00Z",
+ "author": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ }
+ },
+ "latest_check_runs_count": 1,
+ "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs"
+ }
+ ]
+ }
+ },
+ "combined-commit-status": {
+ "value": {
+ "state": "success",
+ "statuses": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "id": 1,
+ "node_id": "MDY6U3RhdHVzMQ==",
+ "state": "success",
+ "description": "Build has completed successfully",
+ "target_url": "https://ci.example.com/1000/output",
+ "context": "continuous-integration/jenkins",
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z"
+ },
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "id": 2,
+ "node_id": "MDY6U3RhdHVzMg==",
+ "state": "success",
+ "description": "Testing has completed successfully",
+ "target_url": "https://ci.example.com/2000/output",
+ "context": "security/brakeman",
+ "created_at": "2012-08-20T01:19:13Z",
+ "updated_at": "2012-08-20T01:19:13Z"
+ }
+ ],
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "total_count": 2,
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status"
+ }
+ },
+ "status-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "id": 1,
+ "node_id": "MDY6U3RhdHVzMQ==",
+ "state": "success",
+ "description": "Build has completed successfully",
+ "target_url": "https://ci.example.com/1000/output",
+ "context": "continuous-integration/jenkins",
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "community-profile": {
+ "value": {
+ "health_percentage": 100,
+ "description": "My first repository on GitHub!",
+ "documentation": null,
+ "files": {
+ "code_of_conduct": {
+ "name": "Contributor Covenant",
+ "key": "contributor_covenant",
+ "url": "https://api.github.com/codes_of_conduct/contributor_covenant",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md"
+ },
+ "code_of_conduct_file": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md"
+ },
+ "contributing": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING"
+ },
+ "issue_template": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE"
+ },
+ "pull_request_template": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE"
+ },
+ "license": {
+ "name": "MIT License",
+ "key": "mit",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ "readme": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md"
+ }
+ },
+ "updated_at": "2017-02-28T19:09:29Z",
+ "content_reports_enabled": true
+ }
+ },
+ "commit-comparison": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic",
+ "html_url": "https://github.com/octocat/Hello-World/compare/master...topic",
+ "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17",
+ "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch",
+ "base_commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ },
+ "merge_base_commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ },
+ "status": "behind",
+ "ahead_by": 1,
+ "behind_by": 2,
+ "total_commits": 1,
+ "commits": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ }
+ ],
+ "files": [
+ {
+ "sha": "bbcd538c8e72b8c175046e27cc8f907076331401",
+ "filename": "file1.txt",
+ "status": "added",
+ "additions": 103,
+ "deletions": 21,
+ "changes": 124,
+ "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
+ }
+ ]
+ }
+ },
+ "content-file-response-if-content-is-a-file": {
+ "summary": "Response if content is a file",
+ "value": {
+ "type": "file",
+ "encoding": "base64",
+ "size": 5362,
+ "name": "README.md",
+ "path": "README.md",
+ "content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n",
+ "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+ "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
+ "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
+ "_links": {
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
+ "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
+ }
+ }
+ },
+ "content-file-response-if-content-is-a-directory-object": {
+ "summary": "Response if content is a directory and the application/vnd.github.v3.object media type is requested",
+ "value": {
+ "type": "dir",
+ "size": 0,
+ "name": "src",
+ "path": "src",
+ "sha": "2962be1c94eaae9794b3080790ec9d74b2fa8358",
+ "url": "https://api.github.com/repos/octocat/octorepo/contents/src?ref=main",
+ "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html_url": "https://github.com/octocat/octorepo/blob/main/src",
+ "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/octorepo/contents/src",
+ "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html": "https://github.com/octocat/octorepo/blob/main/src"
+ },
+ "entries": [
+ {
+ "type": "file",
+ "size": 625,
+ "name": "app.js",
+ "path": "src/app.js",
+ "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "url": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js",
+ "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html_url": "https://github.com/octocat/octorepo/blob/main/src/app.js",
+ "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js",
+ "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html": "https://github.com/octocat/octorepo/blob/main/src/app.js"
+ }
+ },
+ {
+ "type": "dir",
+ "size": 0,
+ "name": "images",
+ "path": "src/images",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "url": "https://api.github.com/repos/octocat/octorepo/contents/src/images",
+ "git_url": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html_url": "https://github.com/octocat/octorepo/tree/main/src/images",
+ "download_url": null,
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/octorepo/contents/src/images",
+ "git": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html": "https://github.com/octocat/octorepo/tree/main/src/images"
+ }
+ }
+ ]
+ }
+ },
+ "content-file-response-if-content-is-a-directory": {
+ "summary": "Response if content is a directory and the application/json media type is requested",
+ "value": [
+ {
+ "type": "file",
+ "size": 625,
+ "name": "octokit.rb",
+ "path": "lib/octokit.rb",
+ "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb",
+ "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb",
+ "_links": {
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb",
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb"
+ }
+ },
+ {
+ "type": "dir",
+ "size": 0,
+ "name": "octokit",
+ "path": "lib/octokit",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit",
+ "download_url": null,
+ "_links": {
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit",
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit"
+ }
+ }
+ ]
+ },
+ "content-file-response-if-content-is-a-symlink": {
+ "summary": "Response if content is a symlink and the application/json media type is requested",
+ "value": {
+ "type": "symlink",
+ "target": "/path/to/symlink/target",
+ "size": 23,
+ "name": "some-symlink",
+ "path": "bin/some-symlink",
+ "sha": "452a98979c88e093d682cab404a3ec82babebb48",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48",
+ "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink",
+ "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink",
+ "_links": {
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48",
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink",
+ "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink"
+ }
+ }
+ },
+ "content-file-response-if-content-is-a-submodule": {
+ "summary": "Response if content is a submodule and the application/json media type is requested",
+ "value": {
+ "type": "submodule",
+ "submodule_git_url": "git://github.com/jquery/qunit.git",
+ "size": 0,
+ "name": "qunit",
+ "path": "test/qunit",
+ "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master",
+ "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "download_url": null,
+ "_links": {
+ "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master",
+ "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9"
+ }
+ }
+ },
+ "file-commit-example-for-updating-a-file": {
+ "value": {
+ "content": {
+ "name": "hello.txt",
+ "path": "notes/hello.txt",
+ "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "size": 9,
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
+ "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt",
+ "type": "file",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
+ }
+ },
+ "commit": {
+ "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f",
+ "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6",
+ "sha": "da5a433788da5c255edad7979b328b67d79f53f6"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ },
+ "file-commit-example-for-creating-a-file": {
+ "value": {
+ "content": {
+ "name": "hello.txt",
+ "path": "notes/hello.txt",
+ "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "size": 9,
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
+ "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt",
+ "type": "file",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
+ }
+ },
+ "commit": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+ "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ },
+ "file-commit": {
+ "value": {
+ "content": null,
+ "commit": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+ "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ },
+ "contributor-items-response-if-repository-contains-content": {
+ "value": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "contributions": 32
+ }
+ ]
+ },
+ "dependabot-alerts-for-repository": {
+ "value": [
+ {
+ "number": 2,
+ "state": "dismissed",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-rf4j-j272-fj86",
+ "cve_id": "CVE-2018-6188",
+ "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
+ "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
+ "first_patched_version": {
+ "identifier": "1.11.10"
+ }
+ }
+ ],
+ "severity": "high",
+ "cvss": {
+ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
+ "score": 7.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-200",
+ "name": "Exposure of Sensitive Information to an Unauthorized Actor"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-rf4j-j272-fj86"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2018-6188"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
+ },
+ {
+ "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
+ },
+ {
+ "url": "https://usn.ubuntu.com/3559-1/"
+ },
+ {
+ "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
+ },
+ {
+ "url": "http://www.securitytracker.com/id/1040422"
+ }
+ ],
+ "published_at": "2018-10-03T21:13:54Z",
+ "updated_at": "2022-04-26T18:35:37Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2",
+ "html_url": "https://github.com/octocat/hello-world/security/dependabot/2",
+ "created_at": "2022-06-15T07:43:03Z",
+ "updated_at": "2022-08-23T14:29:47Z",
+ "dismissed_at": "2022-08-23T14:29:47Z",
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_reason": "tolerable_risk",
+ "dismissed_comment": "This alert is accurate but we use a sanitizer.",
+ "fixed_at": null
+ },
+ {
+ "number": 1,
+ "state": "open",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-8f4m-hccc-8qph",
+ "cve_id": "CVE-2021-20191",
+ "summary": "Insertion of Sensitive Information into Log File in ansible",
+ "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.9.0, < 2.9.18",
+ "first_patched_version": {
+ "identifier": "2.9.18"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.10.0, < 2.10.7",
+ "first_patched_version": {
+ "identifier": "2.10.7"
+ }
+ }
+ ],
+ "severity": "medium",
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
+ "score": 5.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-532",
+ "name": "Insertion of Sensitive Information into Log File"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-8f4m-hccc-8qph"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2021-20191"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"
+ },
+ {
+ "url": "https://access.redhat.com/security/cve/cve-2021-20191"
+ },
+ {
+ "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
+ }
+ ],
+ "published_at": "2021-06-01T17:38:00Z",
+ "updated_at": "2021-08-12T23:06:00Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1",
+ "html_url": "https://github.com/octocat/hello-world/security/dependabot/1",
+ "created_at": "2022-06-14T15:21:52Z",
+ "updated_at": "2022-06-14T15:21:52Z",
+ "dismissed_at": null,
+ "dismissed_by": null,
+ "dismissed_reason": null,
+ "dismissed_comment": null,
+ "fixed_at": null
+ }
+ ]
+ },
+ "dependabot-alert-open": {
+ "value": {
+ "number": 1,
+ "state": "open",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-8f4m-hccc-8qph",
+ "cve_id": "CVE-2021-20191",
+ "summary": "Insertion of Sensitive Information into Log File in ansible",
+ "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.9.0, < 2.9.18",
+ "first_patched_version": {
+ "identifier": "2.9.18"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": ">= 2.10.0, < 2.10.7",
+ "first_patched_version": {
+ "identifier": "2.10.7"
+ }
+ }
+ ],
+ "severity": "medium",
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
+ "score": 5.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-532",
+ "name": "Insertion of Sensitive Information into Log File"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-8f4m-hccc-8qph"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2021-20191"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"
+ },
+ {
+ "url": "https://access.redhat.com/security/cve/cve-2021-20191"
+ },
+ {
+ "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
+ }
+ ],
+ "published_at": "2021-06-01T17:38:00Z",
+ "updated_at": "2021-08-12T23:06:00Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "ansible"
+ },
+ "severity": "medium",
+ "vulnerable_version_range": "< 2.8.19",
+ "first_patched_version": {
+ "identifier": "2.8.19"
+ }
+ },
+ "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1",
+ "html_url": "https://github.com/octocat/hello-world/security/dependabot/1",
+ "created_at": "2022-06-14T15:21:52Z",
+ "updated_at": "2022-06-14T15:21:52Z",
+ "dismissed_at": null,
+ "dismissed_by": null,
+ "dismissed_reason": null,
+ "dismissed_comment": null,
+ "fixed_at": null
+ }
+ },
+ "dependabot-alert-dismissed": {
+ "value": {
+ "number": 2,
+ "state": "dismissed",
+ "dependency": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "manifest_path": "path/to/requirements.txt",
+ "scope": "runtime"
+ },
+ "security_advisory": {
+ "ghsa_id": "GHSA-rf4j-j272-fj86",
+ "cve_id": "CVE-2018-6188",
+ "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
+ "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
+ "first_patched_version": {
+ "identifier": "1.11.10"
+ }
+ }
+ ],
+ "severity": "high",
+ "cvss": {
+ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
+ "score": 7.5
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-200",
+ "name": "Exposure of Sensitive Information to an Unauthorized Actor"
+ }
+ ],
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-rf4j-j272-fj86"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2018-6188"
+ }
+ ],
+ "references": [
+ {
+ "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
+ },
+ {
+ "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
+ },
+ {
+ "url": "https://usn.ubuntu.com/3559-1/"
+ },
+ {
+ "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
+ },
+ {
+ "url": "http://www.securitytracker.com/id/1040422"
+ }
+ ],
+ "published_at": "2018-10-03T21:13:54Z",
+ "updated_at": "2022-04-26T18:35:37Z",
+ "withdrawn_at": null
+ },
+ "security_vulnerability": {
+ "package": {
+ "ecosystem": "pip",
+ "name": "django"
+ },
+ "severity": "high",
+ "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+ "first_patched_version": {
+ "identifier": "2.0.2"
+ }
+ },
+ "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2",
+ "html_url": "https://github.com/octocat/hello-world/security/dependabot/2",
+ "created_at": "2022-06-15T07:43:03Z",
+ "updated_at": "2022-08-23T14:29:47Z",
+ "dismissed_at": "2022-08-23T14:29:47Z",
+ "dismissed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "dismissed_reason": "tolerable_risk",
+ "dismissed_comment": "This alert is accurate but we use a sanitizer.",
+ "fixed_at": null
+ }
+ },
+ "dependabot-secret-paginated": {
+ "value": {
+ "total_count": 2,
+ "secrets": [
+ {
+ "name": "AZURE_DEVOPS_PAT",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z"
+ },
+ {
+ "name": "MY_ARTIFACTORY_PASSWORD",
+ "created_at": "2020-01-10T10:59:22Z",
+ "updated_at": "2020-01-11T11:59:22Z"
+ }
+ ]
+ }
+ },
+ "dependabot-secret": {
+ "value": {
+ "name": "MY_ARTIFACTORY_PASSWORD",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z"
+ }
+ },
+ "diff-range-response": {
+ "value": [
+ {
+ "change_type": "removed",
+ "manifest": "package.json",
+ "ecosystem": "npm",
+ "name": "helmet",
+ "version": "4.6.0",
+ "package_url": "pkg:npm/helmet@4.6.0",
+ "license": "MIT",
+ "source_repository_url": "https://github.com/helmetjs/helmet",
+ "vulnerabilities": [
+
+ ]
+ },
+ {
+ "change_type": "added",
+ "manifest": "package.json",
+ "ecosystem": "npm",
+ "name": "helmet",
+ "version": "5.0.0",
+ "package_url": "pkg:npm/helmet@5.0.0",
+ "license": "MIT",
+ "source_repository_url": "https://github.com/helmetjs/helmet",
+ "vulnerabilities": [
+
+ ]
+ },
+ {
+ "change_type": "added",
+ "manifest": "Gemfile",
+ "ecosystem": "rubygems",
+ "name": "ruby-openid",
+ "version": "2.7.0",
+ "package_url": "pkg:gem/ruby-openid@2.7.0",
+ "license": null,
+ "source_repository_url": "https://github.com/openid/ruby-openid",
+ "vulnerabilities": [
+ {
+ "severity": "critical",
+ "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49",
+ "advisory_summary": "Ruby OpenID",
+ "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49"
+ }
+ ]
+ }
+ ]
+ },
+ "dependency-graph-export-sbom-response": {
+ "value": {
+ "sbom": {
+ "SPDXID": "SPDXRef-DOCUMENT",
+ "spdxVersion": "SPDX-2.3",
+ "creationInfo": {
+ "created": "2021-09-01T00:00:00Z",
+ "creators": [
+ "Tool: GitHub.com-Dependency-Graph"
+ ]
+ },
+ "name": "github/example",
+ "dataLicense": "CC0-1.0",
+ "documentDescribes": [
+ "github/example"
+ ],
+ "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456",
+ "packages": [
+ {
+ "SPDXID": "SPDXRef-Package",
+ "name": "rubygems:rails",
+ "versionInfo": "1.0.0",
+ "downloadLocation": "NOASSERTION",
+ "filesAnalyzed": false,
+ "licenseConcluded": "MIT",
+ "licenseDeclared": "MIT"
+ }
+ ]
+ }
+ }
+ },
+ "dependency-graph-create-snapshot-request": {
+ "value": {
+ "version": 0,
+ "sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "ref": "refs/heads/main",
+ "job": {
+ "correlator": "yourworkflowname_youractionname",
+ "id": "yourrunid"
+ },
+ "detector": {
+ "name": "octo-detector",
+ "version": "0.0.1",
+ "url": "https://github.com/octo-org/octo-repo"
+ },
+ "scanned": "2022-06-14T20:25:00Z",
+ "manifests": {
+ "package-lock.json": {
+ "name": "package-lock.json",
+ "file": {
+ "source_location": "src/package-lock.json"
+ },
+ "resolved": {
+ "@actions/core": {
+ "package_url": "pkg:/npm/%40actions/core@1.1.9",
+ "dependencies": [
+ "@actions/http-client"
+ ]
+ },
+ "@actions/http-client": {
+ "package_url": "pkg:/npm/%40actions/http-client@1.0.7",
+ "dependencies": [
+ "tunnel"
+ ]
+ },
+ "tunnel": {
+ "package_url": "pkg:/npm/tunnel@0.0.6"
+ }
+ }
+ }
+ }
+ }
+ },
+ "dependency-graph-create-snapshot-success": {
+ "value": {
+ "id": 12345,
+ "created_at": "2018-05-04T01:14:52Z",
+ "message": "Dependency results for the repo have been successfully updated.",
+ "result": "SUCCESS"
+ }
+ },
+ "deployment-simple-example": {
+ "summary": "Simple example",
+ "value": {
+ "url": "https://api.github.com/repos/octocat/example/deployments/1",
+ "id": 1,
+ "node_id": "MDEwOkRlcGxveW1lbnQx",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "ref": "topic-branch",
+ "task": "deploy",
+ "payload": {
+ },
+ "original_environment": "staging",
+ "environment": "production",
+ "description": "Deploy request from hubot",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
+ "repository_url": "https://api.github.com/repos/octocat/example",
+ "transient_environment": false,
+ "production_environment": true
+ }
+ },
+ "deployment": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/example/deployments/1",
+ "id": 1,
+ "node_id": "MDEwOkRlcGxveW1lbnQx",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "ref": "topic-branch",
+ "task": "deploy",
+ "payload": {
+ },
+ "original_environment": "staging",
+ "environment": "production",
+ "description": "Deploy request from hubot",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
+ "repository_url": "https://api.github.com/repos/octocat/example",
+ "transient_environment": false,
+ "production_environment": true
+ }
+ },
+ "deployment-status-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1",
+ "id": 1,
+ "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx",
+ "state": "success",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "description": "Deployment finished successfully.",
+ "environment": "production",
+ "target_url": "https://example.com/deployment/42/output",
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42",
+ "repository_url": "https://api.github.com/repos/octocat/example",
+ "environment_url": "https://test-branch.lab.acme.com",
+ "log_url": "https://example.com/deployment/42/output"
+ }
+ ]
+ },
+ "deployment-status": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1",
+ "id": 1,
+ "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx",
+ "state": "success",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "description": "Deployment finished successfully.",
+ "environment": "production",
+ "target_url": "https://example.com/deployment/42/output",
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42",
+ "repository_url": "https://api.github.com/repos/octocat/example",
+ "environment_url": "https://test-branch.lab.acme.com",
+ "log_url": "https://example.com/deployment/42/output"
+ }
+ },
+ "environments": {
+ "value": {
+ "total_count": 1,
+ "environments": [
+ {
+ "id": 161088068,
+ "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
+ "name": "staging",
+ "url": "https://api.github.com/repos/github/hello-world/environments/staging",
+ "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
+ "created_at": "2020-11-23T22:00:40Z",
+ "updated_at": "2020-11-23T22:00:40Z",
+ "protection_rules": [
+ {
+ "id": 3736,
+ "node_id": "MDQ6R2F0ZTM3MzY=",
+ "type": "wait_timer",
+ "wait_timer": 30
+ },
+ {
+ "id": 3755,
+ "node_id": "MDQ6R2F0ZTM3NTU=",
+ "prevent_self_review": false,
+ "type": "required_reviewers",
+ "reviewers": [
+ {
+ "type": "User",
+ "reviewer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ },
+ {
+ "type": "Team",
+ "reviewer": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ }
+ ]
+ },
+ {
+ "id": 3756,
+ "node_id": "MDQ6R2F0ZTM3NTY=",
+ "type": "branch_policy"
+ }
+ ],
+ "deployment_branch_policy": {
+ "protected_branches": false,
+ "custom_branch_policies": true
+ }
+ }
+ ]
+ }
+ },
+ "environment": {
+ "value": {
+ "id": 161088068,
+ "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
+ "name": "staging",
+ "url": "https://api.github.com/repos/github/hello-world/environments/staging",
+ "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
+ "created_at": "2020-11-23T22:00:40Z",
+ "updated_at": "2020-11-23T22:00:40Z",
+ "protection_rules": [
+ {
+ "id": 3736,
+ "node_id": "MDQ6R2F0ZTM3MzY=",
+ "type": "wait_timer",
+ "wait_timer": 30
+ },
+ {
+ "id": 3755,
+ "node_id": "MDQ6R2F0ZTM3NTU=",
+ "prevent_self_review": false,
+ "type": "required_reviewers",
+ "reviewers": [
+ {
+ "type": "User",
+ "reviewer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ },
+ {
+ "type": "Team",
+ "reviewer": {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ }
+ ]
+ },
+ {
+ "id": 3756,
+ "node_id": "MDQ6R2F0ZTM3NTY=",
+ "type": "branch_policy"
+ }
+ ],
+ "deployment_branch_policy": {
+ "protected_branches": false,
+ "custom_branch_policies": true
+ }
+ }
+ },
+ "deployment-branch-policies-list": {
+ "value": {
+ "total_count": 2,
+ "branch_policies": [
+ {
+ "id": 361471,
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
+ "name": "release/*"
+ },
+ {
+ "id": 361472,
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
+ "name": "main"
+ }
+ ]
+ }
+ },
+ "deployment-branch-policy-wildcard": {
+ "value": {
+ "id": 364662,
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
+ "name": "release/*"
+ }
+ },
+ "deployment-branch-policy-single-branch": {
+ "value": {
+ "id": 364663,
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
+ "name": "main"
+ }
+ },
+ "deployment-branch-policy-single-tag": {
+ "value": {
+ "id": 364663,
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
+ "name": "v1",
+ "type": "tag"
+ }
+ },
+ "deployment-protection-rules": {
+ "value": [
+ {
+ "total_count": 2
+ },
+ {
+ "custom_deployment_protection_rules": [
+ {
+ "id": 3,
+ "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
+ "enabled": true,
+ "app": {
+ "id": 1,
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
+ "slug": "a-custom-app",
+ "integration_url": "https://api.github.com/apps/a-custom-app"
+ }
+ },
+ {
+ "id": 4,
+ "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128",
+ "enabled": true,
+ "app": {
+ "id": 1,
+ "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
+ "slug": "another-custom-app",
+ "integration_url": "https://api.github.com/apps/another-custom-app"
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "deployment-protection-rule": {
+ "value": {
+ "id": 3,
+ "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
+ "enabled": true,
+ "app": {
+ "id": 1,
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
+ "slug": "a-custom-app",
+ "integration_url": "https://api.github.com/apps/a-custom-app"
+ }
+ }
+ },
+ "custom-deployment-protection-rule-apps": {
+ "value": [
+ {
+ "total_count": 2
+ },
+ {
+ "available_custom_deployment_protection_rule_integrations": [
+ {
+ "id": 1,
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
+ "slug": "a-custom-app",
+ "integration_url": "https://api.github.com/apps/a-custom-app"
+ },
+ {
+ "id": 2,
+ "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
+ "slug": "another-custom-app",
+ "integration_url": "https://api.github.com/apps/another-custom-app"
+ }
+ ]
+ }
+ ]
+ },
+ "repo-events-items": {
+ "value": [
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22237752260",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-08T23:29:25Z"
+ }
+ ]
+ },
+ "minimal-repository-items-2": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "delete_branch_on_merge": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ },
+ "short-blob": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
+ }
+ },
+ "blob": {
+ "value": {
+ "content": "Q29udGVudCBvZiB0aGUgYmxvYg==",
+ "encoding": "base64",
+ "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "size": 19,
+ "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg=="
+ }
+ },
+ "git-commit": {
+ "value": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132",
+ "sha": "827efc6d56897b048c772eb4087f854f46256132"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0",
+ "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0",
+ "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ },
+ "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
+ }
+ },
+ "git-commit-2": {
+ "value": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "added readme, because im a good github citizen",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+ "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ },
+ "git-ref-items": {
+ "value": [
+ {
+ "ref": "refs/heads/feature-a",
+ "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a",
+ "object": {
+ "type": "commit",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ },
+ {
+ "ref": "refs/heads/feature-b",
+ "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b",
+ "object": {
+ "type": "commit",
+ "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac"
+ }
+ }
+ ]
+ },
+ "git-ref": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
+ "object": {
+ "type": "commit",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
+ },
+ "git-tag": {
+ "value": {
+ "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
+ "tag": "v0.0.1",
+ "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "message": "initial version",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2014-11-07T22:01:45Z"
+ },
+ "object": {
+ "type": "commit",
+ "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
+ },
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ },
+ "git-tree": {
+ "value": {
+ "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7",
+ "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "size": 132,
+ "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b"
+ }
+ ],
+ "truncated": true
+ }
+ },
+ "git-tree-default-response": {
+ "summary": "Default response",
+ "value": {
+ "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "size": 30,
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
+ },
+ {
+ "path": "subdir",
+ "mode": "040000",
+ "type": "tree",
+ "sha": "f484d249c660418515fb01c2b9662073663c242e",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e"
+ },
+ {
+ "path": "exec_file",
+ "mode": "100755",
+ "type": "blob",
+ "size": 75,
+ "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057"
+ }
+ ],
+ "truncated": false
+ }
+ },
+ "git-tree-response-recursively-retrieving-a-tree": {
+ "summary": "Response recursively retrieving a tree",
+ "value": {
+ "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7",
+ "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7",
+ "tree": [
+ {
+ "path": "subdir/file.txt",
+ "mode": "100644",
+ "type": "blob",
+ "size": 132,
+ "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b"
+ }
+ ],
+ "truncated": false
+ }
+ },
+ "hook-items": {
+ "value": [
+ {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ ]
+ },
+ "hook": {
+ "value": {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ },
+ "import": {
+ "value": {
+ "vcs": "subversion",
+ "use_lfs": true,
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "status": "complete",
+ "status_text": "Done",
+ "has_large_files": true,
+ "large_files_size": 132331036,
+ "large_files_count": 1,
+ "authors_count": 4,
+ "url": "https://api.github.com/repos/octocat/socm/import",
+ "html_url": "https://import.github.com/octocat/socm/import",
+ "authors_url": "https://api.github.com/repos/octocat/socm/import/authors",
+ "repository_url": "https://api.github.com/repos/octocat/socm"
+ }
+ },
+ "import-2": {
+ "value": {
+ "vcs": "subversion",
+ "use_lfs": true,
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "status": "importing",
+ "status_text": "Importing...",
+ "has_large_files": false,
+ "large_files_size": 0,
+ "large_files_count": 0,
+ "authors_count": 0,
+ "commit_count": 1042,
+ "url": "https://api.github.com/repos/octocat/socm/import",
+ "html_url": "https://import.github.com/octocat/socm/import",
+ "authors_url": "https://api.github.com/repos/octocat/socm/import/authors",
+ "repository_url": "https://api.github.com/repos/octocat/socm"
+ }
+ },
+ "import-example-1": {
+ "summary": "Example 1",
+ "value": {
+ "vcs": "subversion",
+ "use_lfs": true,
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "status": "detecting",
+ "url": "https://api.github.com/repos/octocat/socm/import",
+ "html_url": "https://import.github.com/octocat/socm/import",
+ "authors_url": "https://api.github.com/repos/octocat/socm/import/authors",
+ "repository_url": "https://api.github.com/repos/octocat/socm"
+ }
+ },
+ "import-example-2": {
+ "summary": "Example 2",
+ "value": {
+ "vcs": "tfvc",
+ "use_lfs": true,
+ "vcs_url": "http://tfs.mycompany.com/tfs/myproject",
+ "tfvc_project": "project1",
+ "status": "importing",
+ "status_text": "Importing...",
+ "has_large_files": false,
+ "large_files_size": 0,
+ "large_files_count": 0,
+ "authors_count": 0,
+ "commit_count": 1042,
+ "url": "https://api.github.com/repos/octocat/socm/import",
+ "html_url": "https://import.github.com/octocat/socm/import",
+ "authors_url": "https://api.github.com/repos/octocat/socm/import/authors",
+ "repository_url": "https://api.github.com/repos/octocat/socm"
+ }
+ },
+ "import-response": {
+ "summary": "Response",
+ "value": {
+ "vcs": "subversion",
+ "use_lfs": true,
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "status": "importing",
+ "status_text": "Importing...",
+ "has_large_files": false,
+ "large_files_size": 0,
+ "large_files_count": 0,
+ "authors_count": 0,
+ "commit_count": 1042,
+ "url": "https://api.github.com/repos/octocat/socm/import",
+ "html_url": "https://import.github.com/octocat/socm/import",
+ "authors_url": "https://api.github.com/repos/octocat/socm/import/authors",
+ "repository_url": "https://api.github.com/repos/octocat/socm"
+ }
+ },
+ "porter-author-items": {
+ "value": [
+ {
+ "id": 2268557,
+ "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "remote_name": "nobody",
+ "email": "hubot@github.com",
+ "name": "Hubot",
+ "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557",
+ "import_url": "https://api.github.com/repos/octocat/socm/import"
+ },
+ {
+ "id": 2268558,
+ "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "remote_name": "svner",
+ "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "name": "svner",
+ "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558",
+ "import_url": "https://api.github.com/repos/octocat/socm/import"
+ },
+ {
+ "id": 2268559,
+ "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "remote_name": "svner@example.com",
+ "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "name": "svner@example.com",
+ "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559",
+ "import_url": "https://api.github.com/repos/octocat/socm/import"
+ }
+ ]
+ },
+ "porter-author": {
+ "value": {
+ "id": 2268557,
+ "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef",
+ "remote_name": "nobody",
+ "email": "hubot@github.com",
+ "name": "Hubot",
+ "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557",
+ "import_url": "https://api.github.com/repos/octocat/socm/import"
+ }
+ },
+ "porter-large-file-items": {
+ "value": [
+ {
+ "ref_name": "refs/heads/master",
+ "path": "foo/bar/1",
+ "oid": "d3d9446802a44259755d38e6d163e820",
+ "size": 10485760
+ },
+ {
+ "ref_name": "refs/heads/master",
+ "path": "foo/bar/2",
+ "oid": "6512bd43d9caa6e02c990b0a82652dca",
+ "size": 11534336
+ },
+ {
+ "ref_name": "refs/heads/master",
+ "path": "foo/bar/3",
+ "oid": "c20ad4d76fe97759aa27a0c99bff6710",
+ "size": 12582912
+ }
+ ]
+ },
+ "interaction-limit-2": {
+ "value": {
+ "limit": "collaborators_only",
+ "origin": "repository",
+ "expires_at": "2018-08-17T04:18:39Z"
+ }
+ },
+ "repository-invitation-items": {
+ "value": [
+ {
+ "id": 1,
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "invitee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "inviter": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "permissions": "write",
+ "created_at": "2016-06-13T14:52:50-05:00",
+ "url": "https://api.github.com/user/repository_invitations/1296269",
+ "html_url": "https://github.com/octocat/Hello-World/invitations",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ]
+ },
+ "repository-invitation": {
+ "value": {
+ "id": 1,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "invitee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "inviter": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "permissions": "write",
+ "created_at": "2016-06-13T14:52:50-05:00",
+ "expired": false,
+ "url": "https://api.github.com/user/repository_invitations/1296269",
+ "html_url": "https://github.com/octocat/Hello-World/invitations"
+ }
+ },
+ "issue-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "closed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "author_association": "COLLABORATOR",
+ "state_reason": "completed"
+ }
+ ]
+ },
+ "issue": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "closed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "author_association": "COLLABORATOR",
+ "state_reason": "completed"
+ }
+ },
+ "issue-comment-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDEyOklzc3VlQ29tbWVudDE=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
+ "body": "Me too",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "author_association": "COLLABORATOR"
+ }
+ ]
+ },
+ "issue-comment": {
+ "value": {
+ "id": 1,
+ "node_id": "MDEyOklzc3VlQ29tbWVudDE=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
+ "body": "Me too",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "issue-event-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDEwOklzc3VlRXZlbnQx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "closed",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "created_at": "2011-04-14T16:00:49Z",
+ "issue": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "COLLABORATOR",
+ "state_reason": "completed"
+ }
+ }
+ ]
+ },
+ "issue-event": {
+ "value": {
+ "id": 1,
+ "node_id": "MDEwOklzc3VlRXZlbnQx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "closed",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "created_at": "2011-04-14T16:00:49Z",
+ "issue": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "performed_via_github_app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "COLLABORATOR",
+ "state_reason": "completed"
+ }
+ }
+ },
+ "issue-event-for-issue-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDEwOklzc3VlRXZlbnQx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "closed",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "created_at": "2011-04-14T16:00:49Z",
+ "performed_via_github_app": null,
+ "label": {
+ "name": "label",
+ "color": "red"
+ }
+ }
+ ]
+ },
+ "label-items": {
+ "value": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ },
+ {
+ "id": 208045947,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
+ "name": "enhancement",
+ "description": "New feature or request",
+ "color": "a2eeef",
+ "default": false
+ }
+ ]
+ },
+ "label-items-2": {
+ "value": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ]
+ },
+ "timeline-issue-events": {
+ "value": [
+ {
+ "id": 6430295168,
+ "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA",
+ "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168",
+ "actor": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "event": "locked",
+ "commit_id": null,
+ "commit_url": null,
+ "created_at": "2022-04-13T20:49:13Z",
+ "lock_reason": null,
+ "performed_via_github_app": null
+ },
+ {
+ "id": 6430296748,
+ "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs",
+ "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748",
+ "actor": {
+ "login": "github-product-roadmap",
+ "id": 67656570,
+ "node_id": "MDQ6VXNlcjY3NjU2NTcw",
+ "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github-product-roadmap",
+ "html_url": "https://github.com/github-product-roadmap",
+ "followers_url": "https://api.github.com/users/github-product-roadmap/followers",
+ "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
+ "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
+ "repos_url": "https://api.github.com/users/github-product-roadmap/repos",
+ "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "labeled",
+ "commit_id": null,
+ "commit_url": null,
+ "created_at": "2022-04-13T20:49:34Z",
+ "label": {
+ "name": "beta",
+ "color": "99dd88"
+ },
+ "performed_via_github_app": null
+ },
+ {
+ "id": 6635165802,
+ "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq",
+ "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802",
+ "actor": {
+ "login": "github-product-roadmap",
+ "id": 67656570,
+ "node_id": "MDQ6VXNlcjY3NjU2NTcw",
+ "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/github-product-roadmap",
+ "html_url": "https://github.com/github-product-roadmap",
+ "followers_url": "https://api.github.com/users/github-product-roadmap/followers",
+ "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions",
+ "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs",
+ "repos_url": "https://api.github.com/users/github-product-roadmap/repos",
+ "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "renamed",
+ "commit_id": null,
+ "commit_url": null,
+ "created_at": "2022-05-18T19:29:01Z",
+ "rename": {
+ "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)",
+ "to": "Secret scanning: dry-runs for enterprise-level custom patterns"
+ },
+ "performed_via_github_app": null
+ },
+ {
+ "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857",
+ "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857",
+ "issue_url": "https://api.github.com/repos/github/roadmap/issues/493",
+ "id": 1130876857,
+ "node_id": "IC_kwDODwFebM5DZ8-5",
+ "user": {
+ "login": "octocat",
+ "id": 94867353,
+ "node_id": "U_kgDOBaePmQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "created_at": "2022-05-19T00:52:15Z",
+ "updated_at": "2022-05-19T00:52:15Z",
+ "author_association": "COLLABORATOR",
+ "body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/",
+ "reactions": {
+ "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions",
+ "total_count": 0,
+ "+1": 0,
+ "-1": 0,
+ "laugh": 0,
+ "hooray": 0,
+ "confused": 0,
+ "heart": 0,
+ "rocket": 0,
+ "eyes": 0
+ },
+ "performed_via_github_app": null,
+ "event": "commented",
+ "actor": {
+ "login": "octocat",
+ "id": 94867353,
+ "node_id": "U_kgDOBaePmQ",
+ "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ }
+ }
+ ]
+ },
+ "deploy-key-items": {
+ "value": [
+ {
+ "id": 1,
+ "key": "ssh-rsa AAA...",
+ "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
+ "title": "octocat@octomac",
+ "verified": true,
+ "created_at": "2014-12-10T15:53:42Z",
+ "read_only": true,
+ "added_by": "octocat",
+ "last_used": "2022-01-10T15:53:42Z"
+ }
+ ]
+ },
+ "deploy-key": {
+ "value": {
+ "id": 1,
+ "key": "ssh-rsa AAA...",
+ "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
+ "title": "octocat@octomac",
+ "verified": true,
+ "created_at": "2014-12-10T15:53:42Z",
+ "read_only": true,
+ "added_by": "octocat",
+ "last_used": "2022-01-10T15:53:42Z"
+ }
+ },
+ "label": {
+ "value": {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ },
+ "label-2": {
+ "value": {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:",
+ "name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26",
+ "default": true
+ }
+ },
+ "language": {
+ "value": {
+ "C": 78769,
+ "Python": 7769
+ }
+ },
+ "license-content": {
+ "value": {
+ "name": "LICENSE",
+ "path": "LICENSE",
+ "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "size": 1077,
+ "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master",
+ "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE",
+ "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true",
+ "type": "file",
+ "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n",
+ "encoding": "base64",
+ "_links": {
+ "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master",
+ "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "html": "https://github.com/benbalter/gman/blob/master/LICENSE"
+ },
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ },
+ "merged-upstream": {
+ "value": {
+ "message": "Successfully fetched and fast-forwarded from upstream defunkt:main",
+ "merge_type": "fast-forward",
+ "base_branch": "defunkt:main"
+ }
+ },
+ "milestone-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ ]
+ },
+ "milestone": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ },
+ "page": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages",
+ "status": "built",
+ "cname": "developer.github.com",
+ "custom_404": false,
+ "html_url": "https://developer.github.com",
+ "source": {
+ "branch": "master",
+ "path": "/"
+ },
+ "public": true,
+ "https_certificate": {
+ "state": "approved",
+ "description": "Certificate is approved",
+ "domains": [
+ "developer.github.com"
+ ],
+ "expires_at": "2021-05-22"
+ },
+ "https_enforced": true
+ }
+ },
+ "page-build-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+ "status": "built",
+ "error": {
+ "message": null
+ },
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
+ "duration": 2104,
+ "created_at": "2014-02-10T19:00:49Z",
+ "updated_at": "2014-02-10T19:00:51Z"
+ }
+ ]
+ },
+ "page-build-status": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest",
+ "status": "queued"
+ }
+ },
+ "page-build": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+ "status": "built",
+ "error": {
+ "message": null
+ },
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
+ "duration": 2104,
+ "created_at": "2014-02-10T19:00:49Z",
+ "updated_at": "2014-02-10T19:00:51Z"
+ }
+ },
+ "page-deployment": {
+ "value": {
+ "id": "4fd754f7e594640989b406850d0bc8f06a121251",
+ "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status",
+ "page_url": "developer.github.com"
+ }
+ },
+ "pages-deployment-status": {
+ "value": {
+ "status": "succeed"
+ }
+ },
+ "pages-health-check": {
+ "value": {
+ "domain": {
+ "host": "example.com",
+ "uri": "http://example.com/",
+ "nameservers": "default",
+ "dns_resolves": true,
+ "is_proxied": false,
+ "is_cloudflare_ip": false,
+ "is_fastly_ip": false,
+ "is_old_ip_address": false,
+ "is_a_record": true,
+ "has_cname_record": false,
+ "has_mx_records_present": false,
+ "is_valid_domain": true,
+ "is_apex_domain": true,
+ "should_be_a_record": true,
+ "is_cname_to_github_user_domain": false,
+ "is_cname_to_pages_dot_github_dot_com": false,
+ "is_cname_to_fastly": false,
+ "is_pointed_to_github_pages_ip": true,
+ "is_non_github_pages_ip_present": false,
+ "is_pages_domain": false,
+ "is_served_by_pages": true,
+ "is_valid": true,
+ "reason": null,
+ "responds_to_https": true,
+ "enforces_https": true,
+ "https_error": null,
+ "is_https_eligible": true,
+ "caa_error": null
+ },
+ "alt_domain": {
+ "host": "www.example.com",
+ "uri": "http://www.example.com/",
+ "nameservers": "default",
+ "dns_resolves": true,
+ "is_proxied": false,
+ "is_cloudflare_ip": false,
+ "is_fastly_ip": false,
+ "is_old_ip_address": false,
+ "is_a_record": true,
+ "has_cname_record": false,
+ "has_mx_records_present": false,
+ "is_valid_domain": true,
+ "is_apex_domain": true,
+ "should_be_a_record": true,
+ "is_cname_to_github_user_domain": false,
+ "is_cname_to_pages_dot_github_dot_com": false,
+ "is_cname_to_fastly": false,
+ "is_pointed_to_github_pages_ip": true,
+ "is_non_github_pages_ip_present": false,
+ "is_pages_domain": false,
+ "is_served_by_pages": true,
+ "is_valid": true,
+ "reason": null,
+ "responds_to_https": true,
+ "enforces_https": true,
+ "https_error": null,
+ "is_https_eligible": true,
+ "caa_error": null
+ }
+ }
+ },
+ "project-items-2": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/repos/api-playground/projects-test",
+ "url": "https://api.github.com/projects/1002604",
+ "html_url": "https://github.com/api-playground/projects-test/projects/1",
+ "columns_url": "https://api.github.com/projects/1002604/columns",
+ "id": 1002604,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=",
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z"
+ }
+ ]
+ },
+ "custom-property-values": {
+ "value": [
+ {
+ "property_name": "environment",
+ "value": "production"
+ },
+ {
+ "property_name": "service",
+ "value": "web"
+ },
+ {
+ "property_name": "team",
+ "value": "octocat"
+ }
+ ]
+ },
+ "create-or-update-custom-properties-values": {
+ "value": {
+ "properties": [
+ {
+ "property_name": "environment",
+ "value": "production"
+ },
+ {
+ "property_name": "service",
+ "value": "web"
+ },
+ {
+ "property_name": "team",
+ "value": "octocat"
+ }
+ ]
+ }
+ },
+ "pull-request": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "id": 1,
+ "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
+ "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
+ "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "number": 1347,
+ "state": "open",
+ "locked": true,
+ "title": "Amazing new feature",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Please pull these awesome changes in!",
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "active_lock_reason": "too heated",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:01:12Z",
+ "closed_at": "2011-01-26T19:01:12Z",
+ "merged_at": "2011-01-26T19:01:12Z",
+ "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ }
+ ],
+ "requested_reviewers": [
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "requested_teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "allow_forking": true,
+ "forks": 123,
+ "open_issues": 123,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ "watchers": 123
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "forks": 123,
+ "open_issues": 123,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ "watchers": 123
+ }
+ },
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "issue": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "review_comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "commits": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "statuses": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ },
+ "author_association": "OWNER",
+ "auto_merge": null,
+ "draft": false,
+ "merged": false,
+ "mergeable": true,
+ "rebaseable": true,
+ "mergeable_state": "clean",
+ "merged_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "comments": 10,
+ "review_comments": 0,
+ "maintainer_can_modify": true,
+ "commits": 3,
+ "additions": 100,
+ "deletions": 3,
+ "changed_files": 5
+ }
+ },
+ "pull-request-review-comment-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "pull_request_review_id": 42,
+ "id": 10,
+ "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
+ "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
+ "path": "file1.txt",
+ "position": 1,
+ "original_position": 4,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "in_reply_to_id": 8,
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Great stuff!",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "author_association": "NONE",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ },
+ "start_line": 1,
+ "original_start_line": 1,
+ "start_side": "RIGHT",
+ "line": 2,
+ "original_line": 2,
+ "side": "RIGHT"
+ }
+ ]
+ },
+ "pull-request-review-comment-2": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "pull_request_review_id": 42,
+ "id": 10,
+ "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
+ "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
+ "path": "file1.txt",
+ "position": 1,
+ "original_position": 4,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "in_reply_to_id": 8,
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Great stuff!",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "author_association": "NONE",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ },
+ "start_line": 1,
+ "original_start_line": 1,
+ "start_side": "RIGHT",
+ "line": 2,
+ "original_line": 2,
+ "side": "RIGHT"
+ }
+ },
+ "pull-request-review-comment-example-for-a-multi-line-comment": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "pull_request_review_id": 42,
+ "id": 10,
+ "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
+ "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
+ "path": "file1.txt",
+ "position": 1,
+ "original_position": 4,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "in_reply_to_id": 8,
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Great stuff!",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "author_association": "NONE",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ },
+ "start_line": 1,
+ "original_start_line": 1,
+ "start_side": "RIGHT",
+ "line": 2,
+ "original_line": 2,
+ "side": "RIGHT"
+ }
+ },
+ "pull-request-review-comment": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "pull_request_review_id": 42,
+ "id": 10,
+ "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
+ "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
+ "path": "file1.txt",
+ "position": 1,
+ "original_position": 4,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "in_reply_to_id": 426899381,
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Great stuff!",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "author_association": "NONE",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ },
+ "start_line": 1,
+ "original_start_line": 1,
+ "start_side": "RIGHT",
+ "line": 2,
+ "original_line": 2,
+ "side": "RIGHT"
+ }
+ },
+ "diff-entry-items": {
+ "value": [
+ {
+ "sha": "bbcd538c8e72b8c175046e27cc8f907076331401",
+ "filename": "file1.txt",
+ "status": "added",
+ "additions": 103,
+ "deletions": 21,
+ "changes": 124,
+ "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
+ }
+ ]
+ },
+ "pull-request-merge-result-response-if-merge-was-successful": {
+ "value": {
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "merged": true,
+ "message": "Pull Request successfully merged"
+ }
+ },
+ "simple-pull-request-review-request": {
+ "value": {
+ "users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ]
+ }
+ },
+ "pull-request-review-request": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "id": 1,
+ "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
+ "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
+ "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "number": 1347,
+ "state": "open",
+ "locked": true,
+ "title": "Amazing new feature",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Please pull these awesome changes in!",
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "active_lock_reason": "too heated",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:01:12Z",
+ "closed_at": "2011-01-26T19:01:12Z",
+ "merged_at": "2011-01-26T19:01:12Z",
+ "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ }
+ ],
+ "requested_reviewers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "requested_teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "issue": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "review_comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "commits": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "statuses": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ },
+ "author_association": "OWNER",
+ "auto_merge": null,
+ "draft": false
+ }
+ },
+ "pull-request-simple": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "id": 1,
+ "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
+ "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
+ "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
+ "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "number": 1347,
+ "state": "open",
+ "locked": true,
+ "title": "Amazing new feature",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Please pull these awesome changes in!",
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "active_lock_reason": "too heated",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:01:12Z",
+ "closed_at": "2011-01-26T19:01:12Z",
+ "merged_at": "2011-01-26T19:01:12Z",
+ "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ }
+ ],
+ "requested_reviewers": [
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "requested_teams": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1347"
+ },
+ "issue": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ },
+ "comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
+ },
+ "review_comments": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
+ },
+ "review_comment": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
+ },
+ "commits": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
+ },
+ "statuses": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ },
+ "author_association": "OWNER",
+ "auto_merge": null,
+ "draft": false
+ }
+ },
+ "pull-request-review-items": {
+ "value": [
+ {
+ "id": 80,
+ "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Here is the body for the review.",
+ "state": "APPROVED",
+ "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
+ "_links": {
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ }
+ },
+ "submitted_at": "2019-11-17T17:43:43Z",
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "author_association": "COLLABORATOR"
+ }
+ ]
+ },
+ "pull-request-review": {
+ "value": {
+ "id": 80,
+ "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "state": "CHANGES_REQUESTED",
+ "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
+ "_links": {
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ }
+ },
+ "submitted_at": "2019-11-17T17:43:43Z",
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "pull-request-review-4": {
+ "value": {
+ "id": 80,
+ "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Here is the body for the review.",
+ "state": "APPROVED",
+ "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
+ "_links": {
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ }
+ },
+ "submitted_at": "2019-11-17T17:43:43Z",
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "pull-request-review-5": {
+ "value": {
+ "id": 80,
+ "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "This is close to perfect! Please address the suggested inline change. And add more about this.",
+ "state": "CHANGES_REQUESTED",
+ "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
+ "_links": {
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ }
+ },
+ "submitted_at": "2019-11-17T17:43:43Z",
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "review-comment-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "pull_request_review_id": 42,
+ "id": 10,
+ "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
+ "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
+ "path": "file1.txt",
+ "position": 1,
+ "original_position": 4,
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
+ "in_reply_to_id": 8,
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Great stuff!",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "author_association": "NONE",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
+ },
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
+ }
+ }
+ }
+ ]
+ },
+ "pull-request-review-3": {
+ "value": {
+ "id": 80,
+ "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Here is the body for the review.",
+ "state": "DISMISSED",
+ "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80",
+ "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12",
+ "_links": {
+ "html": {
+ "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
+ },
+ "pull_request": {
+ "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
+ }
+ },
+ "submitted_at": "2019-11-17T17:43:43Z",
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "author_association": "COLLABORATOR"
+ }
+ },
+ "content-file": {
+ "value": {
+ "type": "file",
+ "encoding": "base64",
+ "size": 5362,
+ "name": "README.md",
+ "path": "README.md",
+ "content": "encoded content ...",
+ "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+ "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
+ "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
+ "_links": {
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
+ "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
+ }
+ }
+ },
+ "release-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
+ "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
+ "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
+ "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
+ "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
+ "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
+ "id": 1,
+ "node_id": "MDc6UmVsZWFzZTE=",
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "created_at": "2013-02-27T19:35:32Z",
+ "published_at": "2013-02-27T19:35:32Z",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assets": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
+ "id": 1,
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
+ "name": "example.zip",
+ "label": "short description",
+ "state": "uploaded",
+ "content_type": "application/zip",
+ "size": 1024,
+ "download_count": 42,
+ "created_at": "2013-02-27T19:35:32Z",
+ "updated_at": "2013-02-27T19:35:32Z",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "release": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
+ "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
+ "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
+ "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
+ "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
+ "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
+ "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
+ "id": 1,
+ "node_id": "MDc6UmVsZWFzZTE=",
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "created_at": "2013-02-27T19:35:32Z",
+ "published_at": "2013-02-27T19:35:32Z",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assets": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
+ "id": 1,
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
+ "name": "example.zip",
+ "label": "short description",
+ "state": "uploaded",
+ "content_type": "application/zip",
+ "size": 1024,
+ "download_count": 42,
+ "created_at": "2013-02-27T19:35:32Z",
+ "updated_at": "2013-02-27T19:35:32Z",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ }
+ },
+ "release-asset": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
+ "id": 1,
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
+ "name": "example.zip",
+ "label": "short description",
+ "state": "uploaded",
+ "content_type": "application/zip",
+ "size": 1024,
+ "download_count": 42,
+ "created_at": "2013-02-27T19:35:32Z",
+ "updated_at": "2013-02-27T19:35:32Z",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "release-notes-content": {
+ "value": {
+ "name": "Release v1.0.0 is now available!",
+ "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa"
+ }
+ },
+ "release-asset-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
+ "id": 1,
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
+ "name": "example.zip",
+ "label": "short description",
+ "state": "uploaded",
+ "content_type": "application/zip",
+ "size": 1024,
+ "download_count": 42,
+ "created_at": "2013-02-27T19:35:32Z",
+ "updated_at": "2013-02-27T19:35:32Z",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "release-asset-response-for-successful-upload": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
+ "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
+ "id": 1,
+ "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
+ "name": "example.zip",
+ "label": "short description",
+ "state": "uploaded",
+ "content_type": "application/zip",
+ "size": 1024,
+ "download_count": 42,
+ "created_at": "2013-02-27T19:35:32Z",
+ "updated_at": "2013-02-27T19:35:32Z",
+ "uploader": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "repository-rule-items": {
+ "value": [
+ {
+ "type": "commit_message_pattern",
+ "ruleset_source_type": "Repository",
+ "ruleset_source": "monalisa/my-repo",
+ "ruleset_id": 42,
+ "parameters": {
+ "operator": "starts_with",
+ "pattern": "issue"
+ }
+ },
+ {
+ "type": "commit_author_email_pattern",
+ "ruleset_source_type": "Organization",
+ "ruleset_source": "my-org",
+ "ruleset_id": 73,
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ]
+ },
+ "repository-ruleset-items": {
+ "value": [
+ {
+ "id": 42,
+ "name": "super cool ruleset",
+ "source_type": "Repository",
+ "source": "monalisa/my-repo",
+ "enforcement": "enabled",
+ "node_id": "RRS_lACkVXNlcgQB",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42"
+ },
+ "html": {
+ "href": "https://github.com/monalisa/my-repo/rules/42"
+ }
+ },
+ "created_at": "2023-07-15T08:43:03Z",
+ "updated_at": "2023-08-23T16:29:47Z"
+ },
+ {
+ "id": 314,
+ "name": "Another ruleset",
+ "source_type": "Repository",
+ "source": "monalisa/my-repo",
+ "enforcement": "enabled",
+ "node_id": "RRS_lACkVXNlcgQQ",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314"
+ },
+ "html": {
+ "href": "https://github.com/monalisa/my-repo/rules/314"
+ }
+ },
+ "created_at": "2023-08-15T08:43:03Z",
+ "updated_at": "2023-09-23T16:29:47Z"
+ }
+ ]
+ },
+ "repository-ruleset": {
+ "value": {
+ "id": 42,
+ "name": "super cool ruleset",
+ "target": "branch",
+ "source_type": "Repository",
+ "source": "monalisa/my-repo",
+ "enforcement": "active",
+ "bypass_actors": [
+ {
+ "actor_id": 234,
+ "actor_type": "Team",
+ "bypass_mode": "always"
+ }
+ ],
+ "conditions": {
+ "ref_name": {
+ "include": [
+ "refs/heads/main",
+ "refs/heads/master"
+ ],
+ "exclude": [
+ "refs/heads/dev*"
+ ]
+ }
+ },
+ "rules": [
+ {
+ "type": "commit_author_email_pattern",
+ "parameters": {
+ "operator": "contains",
+ "pattern": "github"
+ }
+ }
+ ],
+ "node_id": "RRS_lACkVXNlcgQB",
+ "_links": {
+ "self": {
+ "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42"
+ },
+ "html": {
+ "href": "https://github.com/monalisa/my-repo/rules/42"
+ }
+ },
+ "created_at": "2023-07-15T08:43:03Z",
+ "updated_at": "2023-08-23T16:29:47Z"
+ }
+ },
+ "secret-scanning-alert-list": {
+ "value": [
+ {
+ "number": 2,
+ "created_at": "2020-11-06T18:48:51Z",
+ "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2",
+ "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations",
+ "state": "resolved",
+ "resolution": "false_positive",
+ "resolved_at": "2020-11-07T02:47:13Z",
+ "resolved_by": {
+ "login": "monalisa",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjI=",
+ "avatar_url": "https://alambic.github.com/avatars/u/2?",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "secret_type": "adafruit_io_key",
+ "secret_type_display_name": "Adafruit IO Key",
+ "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+ "push_protection_bypassed_by": {
+ "login": "monalisa",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjI=",
+ "avatar_url": "https://alambic.github.com/avatars/u/2?",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "push_protection_bypassed": true,
+ "push_protection_bypassed_at": "2020-11-06T21:48:51Z",
+ "resolution_comment": "Example comment",
+ "validity": "inactive"
+ },
+ {
+ "number": 1,
+ "created_at": "2020-11-06T18:18:30Z",
+ "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1",
+ "html_url": "https://github.com/owner/repo/security/secret-scanning/1",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations",
+ "state": "open",
+ "resolution": null,
+ "resolved_at": null,
+ "resolved_by": null,
+ "secret_type": "mailchimp_api_key",
+ "secret_type_display_name": "Mailchimp API Key",
+ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
+ "push_protection_bypassed_by": null,
+ "push_protection_bypassed": false,
+ "push_protection_bypassed_at": null,
+ "resolution_comment": null,
+ "validity": "unknown"
+ }
+ ]
+ },
+ "secret-scanning-alert-open": {
+ "value": {
+ "number": 42,
+ "created_at": "2020-11-06T18:18:30Z",
+ "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42",
+ "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
+ "state": "open",
+ "resolution": null,
+ "resolved_at": null,
+ "resolved_by": null,
+ "secret_type": "mailchimp_api_key",
+ "secret_type_display_name": "Mailchimp API Key",
+ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
+ "push_protection_bypassed_by": null,
+ "push_protection_bypassed": false,
+ "push_protection_bypassed_at": null,
+ "resolution_comment": null,
+ "validity": "unknown"
+ }
+ },
+ "secret-scanning-alert-resolved": {
+ "value": {
+ "number": 42,
+ "created_at": "2020-11-06T18:18:30Z",
+ "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42",
+ "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
+ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
+ "state": "resolved",
+ "resolution": "used_in_tests",
+ "resolved_at": "2020-11-16T22:42:07Z",
+ "resolved_by": {
+ "login": "monalisa",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjI=",
+ "avatar_url": "https://alambic.github.com/avatars/u/2?",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "secret_type": "mailchimp_api_key",
+ "secret_type_display_name": "Mailchimp API Key",
+ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
+ "push_protection_bypassed": false,
+ "push_protection_bypassed_by": null,
+ "push_protection_bypassed_at": null,
+ "resolution_comment": "Example comment",
+ "validity": "unknown"
+ }
+ },
+ "secret-scanning-location-list": {
+ "value": [
+ {
+ "type": "commit",
+ "details": {
+ "path": "/example/secrets.txt",
+ "start_line": 1,
+ "end_line": 1,
+ "start_column": 1,
+ "end_column": 64,
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
+ "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b",
+ "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b",
+ "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
+ }
+ },
+ {
+ "type": "issue_title",
+ "details": {
+ "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ }
+ },
+ {
+ "type": "issue_body",
+ "details": {
+ "issue_body_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
+ }
+ },
+ {
+ "type": "issue_comment",
+ "details": {
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451"
+ }
+ },
+ {
+ "type": "discussion_title",
+ "details": {
+ "discussion_title_url": "https://github.com/community/community/discussions/39082"
+ }
+ },
+ {
+ "type": "discussion_body",
+ "details": {
+ "discussion_body_url": "https://github.com/community/community/discussions/39082#discussion-4566270"
+ }
+ },
+ {
+ "type": "discussion_comment",
+ "details": {
+ "discussion_comment_url": "https://github.com/community/community/discussions/39082#discussioncomment-4158232"
+ }
+ },
+ {
+ "type": "pull_request_title",
+ "details": {
+ "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846"
+ }
+ },
+ {
+ "type": "pull_request_body",
+ "details": {
+ "pull_request_body_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846"
+ }
+ },
+ {
+ "type": "pull_request_comment",
+ "details": {
+ "pull_request_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898"
+ }
+ },
+ {
+ "type": "pull_request_review",
+ "details": {
+ "pull_request_review_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80"
+ }
+ },
+ {
+ "type": "pull_request_review_comment",
+ "details": {
+ "pull_request_review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12"
+ }
+ }
+ ]
+ },
+ "repository-advisory": {
+ "value": {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "critical",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-01T00:00:00Z",
+ "updated_at": "2020-01-02T00:00:00Z",
+ "published_at": "2020-01-03T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
+ "score": 9.8
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-123",
+ "name": "A CWE"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ],
+ "credits": [
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ],
+ "private_fork": {
+ "id": 217723378,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
+ "name": "octo-repo-ghsa-abcd-1234-efgh",
+ "full_name": "octo-org/octo-repo-ghsa-abcd-1234-efgh",
+ "owner": {
+ "login": "octo-org",
+ "id": 6811672,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octo-org",
+ "html_url": "https://github.com/octo-org",
+ "followers_url": "https://api.github.com/users/octo-org/followers",
+ "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
+ "organizations_url": "https://api.github.com/users/octo-org/orgs",
+ "repos_url": "https://api.github.com/users/octo-org/repos",
+ "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octo-org/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "private": true,
+ "html_url": "https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh",
+ "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors",
+ "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments",
+ "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads",
+ "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events",
+ "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks",
+ "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha}",
+ "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks",
+ "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages",
+ "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges",
+ "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id}",
+ "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers",
+ "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers",
+ "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription",
+ "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags",
+ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams",
+ "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}"
+ }
+ }
+ },
+ "repository-advisory-pvr": {
+ "value": {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
+ "summary": "A newly discovered vulnerability",
+ "description": "A more in-depth description of what the problem is.",
+ "severity": "high",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": null,
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": null
+ }
+ ],
+ "state": "triage",
+ "created_at": "2020-01-01T00:00:00Z",
+ "updated_at": "2020-01-02T00:00:00Z",
+ "published_at": null,
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": {
+ "accepted": false
+ },
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "npm",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": "< 1.0.0",
+ "patched_versions": "1.0.0",
+ "vulnerable_functions": [
+ "important_function"
+ ]
+ }
+ ],
+ "cvss": null,
+ "cwes": [
+ {
+ "cwe_id": "CWE-123",
+ "name": "A CWE"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ],
+ "credits": [
+ {
+ "login": "octocat",
+ "type": "finder"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "finder",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ],
+ "private_fork": null
+ }
+ },
+ "simple-user-items-default-response": {
+ "summary": "Default response",
+ "value": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ]
+ },
+ "stargazer-items-alternative-response-with-star-creation-timestamps": {
+ "summary": "Alternative response with star creation timestamps",
+ "value": [
+ {
+ "starred_at": "2011-01-16T19:06:43Z",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "code-frequency-stat-items": {
+ "value": [
+ [
+ 1302998400,
+ 1124,
+ -435
+ ]
+ ]
+ },
+ "commit-activity-items": {
+ "value": [
+ {
+ "days": [
+ 0,
+ 3,
+ 26,
+ 20,
+ 39,
+ 1,
+ 0
+ ],
+ "total": 89,
+ "week": 1336280400
+ }
+ ]
+ },
+ "contributor-activity-items": {
+ "value": [
+ {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "total": 135,
+ "weeks": [
+ {
+ "w": 1367712000,
+ "a": 6898,
+ "d": 77,
+ "c": 10
+ }
+ ]
+ }
+ ]
+ },
+ "participation-stats": {
+ "value": {
+ "all": [
+ 11,
+ 21,
+ 15,
+ 2,
+ 8,
+ 1,
+ 8,
+ 23,
+ 17,
+ 21,
+ 11,
+ 10,
+ 33,
+ 91,
+ 38,
+ 34,
+ 22,
+ 23,
+ 32,
+ 3,
+ 43,
+ 87,
+ 71,
+ 18,
+ 13,
+ 5,
+ 13,
+ 16,
+ 66,
+ 27,
+ 12,
+ 45,
+ 110,
+ 117,
+ 13,
+ 8,
+ 18,
+ 9,
+ 19,
+ 26,
+ 39,
+ 12,
+ 20,
+ 31,
+ 46,
+ 91,
+ 45,
+ 10,
+ 24,
+ 9,
+ 29,
+ 7
+ ],
+ "owner": [
+ 3,
+ 2,
+ 3,
+ 0,
+ 2,
+ 0,
+ 5,
+ 14,
+ 7,
+ 9,
+ 1,
+ 5,
+ 0,
+ 48,
+ 19,
+ 2,
+ 0,
+ 1,
+ 10,
+ 2,
+ 23,
+ 40,
+ 35,
+ 8,
+ 8,
+ 2,
+ 10,
+ 6,
+ 30,
+ 0,
+ 2,
+ 9,
+ 53,
+ 104,
+ 3,
+ 3,
+ 10,
+ 4,
+ 7,
+ 11,
+ 21,
+ 4,
+ 4,
+ 22,
+ 26,
+ 63,
+ 11,
+ 2,
+ 14,
+ 1,
+ 10,
+ 3
+ ]
+ }
+ },
+ "code-frequency-stat-items-2": {
+ "value": [
+ [
+ 0,
+ 0,
+ 5
+ ],
+ [
+ 0,
+ 1,
+ 43
+ ],
+ [
+ 0,
+ 2,
+ 21
+ ]
+ ]
+ },
+ "status": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "id": 1,
+ "node_id": "MDY6U3RhdHVzMQ==",
+ "state": "success",
+ "description": "Build has completed successfully",
+ "target_url": "https://ci.example.com/1000/output",
+ "context": "continuous-integration/jenkins",
+ "created_at": "2012-07-20T01:19:13Z",
+ "updated_at": "2012-07-20T01:19:13Z",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "repository-subscription-response-if-you-subscribe-to-the-repository": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/repos/octocat/example/subscription",
+ "repository_url": "https://api.github.com/repos/octocat/example"
+ }
+ },
+ "repository-subscription": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/repos/octocat/example/subscription",
+ "repository_url": "https://api.github.com/repos/octocat/example"
+ }
+ },
+ "tag-items": {
+ "value": [
+ {
+ "name": "v0.1",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1",
+ "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ]
+ },
+ "tag-protection-items": {
+ "value": [
+ {
+ "id": 2,
+ "pattern": "v1.*"
+ }
+ ]
+ },
+ "tag-protection": {
+ "value": {
+ "enabled": true
+ }
+ },
+ "topic": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ },
+ "clone-traffic": {
+ "value": {
+ "count": 173,
+ "uniques": 128,
+ "clones": [
+ {
+ "timestamp": "2016-10-10T00:00:00Z",
+ "count": 2,
+ "uniques": 1
+ },
+ {
+ "timestamp": "2016-10-11T00:00:00Z",
+ "count": 17,
+ "uniques": 16
+ },
+ {
+ "timestamp": "2016-10-12T00:00:00Z",
+ "count": 21,
+ "uniques": 15
+ },
+ {
+ "timestamp": "2016-10-13T00:00:00Z",
+ "count": 8,
+ "uniques": 7
+ },
+ {
+ "timestamp": "2016-10-14T00:00:00Z",
+ "count": 5,
+ "uniques": 5
+ },
+ {
+ "timestamp": "2016-10-15T00:00:00Z",
+ "count": 2,
+ "uniques": 2
+ },
+ {
+ "timestamp": "2016-10-16T00:00:00Z",
+ "count": 8,
+ "uniques": 7
+ },
+ {
+ "timestamp": "2016-10-17T00:00:00Z",
+ "count": 26,
+ "uniques": 15
+ },
+ {
+ "timestamp": "2016-10-18T00:00:00Z",
+ "count": 19,
+ "uniques": 17
+ },
+ {
+ "timestamp": "2016-10-19T00:00:00Z",
+ "count": 19,
+ "uniques": 14
+ },
+ {
+ "timestamp": "2016-10-20T00:00:00Z",
+ "count": 19,
+ "uniques": 15
+ },
+ {
+ "timestamp": "2016-10-21T00:00:00Z",
+ "count": 9,
+ "uniques": 7
+ },
+ {
+ "timestamp": "2016-10-22T00:00:00Z",
+ "count": 5,
+ "uniques": 5
+ },
+ {
+ "timestamp": "2016-10-23T00:00:00Z",
+ "count": 6,
+ "uniques": 5
+ },
+ {
+ "timestamp": "2016-10-24T00:00:00Z",
+ "count": 7,
+ "uniques": 5
+ }
+ ]
+ }
+ },
+ "content-traffic-items": {
+ "value": [
+ {
+ "path": "/github/hubot",
+ "title": "github/hubot: A customizable life embetterment robot.",
+ "count": 3542,
+ "uniques": 2225
+ },
+ {
+ "path": "/github/hubot/blob/master/docs/scripting.md",
+ "title": "hubot/scripting.md at master · github/hubot · GitHub",
+ "count": 1707,
+ "uniques": 804
+ },
+ {
+ "path": "/github/hubot/tree/master/docs",
+ "title": "hubot/docs at master · github/hubot · GitHub",
+ "count": 685,
+ "uniques": 435
+ },
+ {
+ "path": "/github/hubot/tree/master/src",
+ "title": "hubot/src at master · github/hubot · GitHub",
+ "count": 577,
+ "uniques": 347
+ },
+ {
+ "path": "/github/hubot/blob/master/docs/index.md",
+ "title": "hubot/index.md at master · github/hubot · GitHub",
+ "count": 379,
+ "uniques": 259
+ },
+ {
+ "path": "/github/hubot/blob/master/docs/adapters.md",
+ "title": "hubot/adapters.md at master · github/hubot · GitHub",
+ "count": 354,
+ "uniques": 201
+ },
+ {
+ "path": "/github/hubot/tree/master/examples",
+ "title": "hubot/examples at master · github/hubot · GitHub",
+ "count": 340,
+ "uniques": 260
+ },
+ {
+ "path": "/github/hubot/blob/master/docs/deploying/heroku.md",
+ "title": "hubot/heroku.md at master · github/hubot · GitHub",
+ "count": 324,
+ "uniques": 217
+ },
+ {
+ "path": "/github/hubot/blob/master/src/robot.coffee",
+ "title": "hubot/robot.coffee at master · github/hubot · GitHub",
+ "count": 293,
+ "uniques": 191
+ },
+ {
+ "path": "/github/hubot/blob/master/LICENSE.md",
+ "title": "hubot/LICENSE.md at master · github/hubot · GitHub",
+ "count": 281,
+ "uniques": 222
+ }
+ ]
+ },
+ "referrer-traffic-items": {
+ "value": [
+ {
+ "referrer": "Google",
+ "count": 4,
+ "uniques": 3
+ },
+ {
+ "referrer": "stackoverflow.com",
+ "count": 2,
+ "uniques": 2
+ },
+ {
+ "referrer": "eggsonbread.com",
+ "count": 1,
+ "uniques": 1
+ },
+ {
+ "referrer": "yandex.ru",
+ "count": 1,
+ "uniques": 1
+ }
+ ]
+ },
+ "view-traffic": {
+ "value": {
+ "count": 14850,
+ "uniques": 3782,
+ "views": [
+ {
+ "timestamp": "2016-10-10T00:00:00Z",
+ "count": 440,
+ "uniques": 143
+ },
+ {
+ "timestamp": "2016-10-11T00:00:00Z",
+ "count": 1308,
+ "uniques": 414
+ },
+ {
+ "timestamp": "2016-10-12T00:00:00Z",
+ "count": 1486,
+ "uniques": 452
+ },
+ {
+ "timestamp": "2016-10-13T00:00:00Z",
+ "count": 1170,
+ "uniques": 401
+ },
+ {
+ "timestamp": "2016-10-14T00:00:00Z",
+ "count": 868,
+ "uniques": 266
+ },
+ {
+ "timestamp": "2016-10-15T00:00:00Z",
+ "count": 495,
+ "uniques": 157
+ },
+ {
+ "timestamp": "2016-10-16T00:00:00Z",
+ "count": 524,
+ "uniques": 175
+ },
+ {
+ "timestamp": "2016-10-17T00:00:00Z",
+ "count": 1263,
+ "uniques": 412
+ },
+ {
+ "timestamp": "2016-10-18T00:00:00Z",
+ "count": 1402,
+ "uniques": 417
+ },
+ {
+ "timestamp": "2016-10-19T00:00:00Z",
+ "count": 1394,
+ "uniques": 424
+ },
+ {
+ "timestamp": "2016-10-20T00:00:00Z",
+ "count": 1492,
+ "uniques": 448
+ },
+ {
+ "timestamp": "2016-10-21T00:00:00Z",
+ "count": 1153,
+ "uniques": 332
+ },
+ {
+ "timestamp": "2016-10-22T00:00:00Z",
+ "count": 566,
+ "uniques": 168
+ },
+ {
+ "timestamp": "2016-10-23T00:00:00Z",
+ "count": 675,
+ "uniques": 184
+ },
+ {
+ "timestamp": "2016-10-24T00:00:00Z",
+ "count": 614,
+ "uniques": 237
+ }
+ ]
+ }
+ },
+ "minimal-repository": {
+ "value": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "allow_forking": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ }
+ }
+ },
+ "public-repository-items": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ }
+ ]
+ },
+ "code-search-result-item-paginated": {
+ "value": {
+ "total_count": 7,
+ "incomplete_results": false,
+ "items": [
+ {
+ "name": "classes.js",
+ "path": "src/attributes/classes.js",
+ "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a",
+ "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4",
+ "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a",
+ "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js",
+ "repository": {
+ "id": 167174,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=",
+ "name": "jquery",
+ "full_name": "jquery/jquery",
+ "owner": {
+ "login": "jquery",
+ "id": 70142,
+ "node_id": "MDQ6VXNlcjcwMTQy",
+ "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/jquery",
+ "html_url": "https://github.com/jquery",
+ "followers_url": "https://api.github.com/users/jquery/followers",
+ "following_url": "https://api.github.com/users/jquery/following{/other_user}",
+ "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/jquery/subscriptions",
+ "organizations_url": "https://api.github.com/users/jquery/orgs",
+ "repos_url": "https://api.github.com/users/jquery/repos",
+ "events_url": "https://api.github.com/users/jquery/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/jquery/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/jquery/jquery",
+ "description": "jQuery JavaScript Library",
+ "fork": false,
+ "url": "https://api.github.com/repos/jquery/jquery",
+ "forks_url": "https://api.github.com/repos/jquery/jquery/forks",
+ "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/jquery/jquery/teams",
+ "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks",
+ "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/jquery/jquery/events",
+ "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/jquery/jquery/tags",
+ "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/jquery/jquery/languages",
+ "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers",
+ "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors",
+ "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers",
+ "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription",
+ "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}",
+ "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/jquery/jquery/merges",
+ "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads",
+ "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}",
+ "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
+ "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "score": 1
+ }
+ ]
+ }
+ },
+ "commit-search-result-item-paginated": {
+ "value": {
+ "total_count": 1,
+ "incomplete_results": false,
+ "items": [
+ {
+ "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f",
+ "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f",
+ "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f",
+ "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f",
+ "author": {
+ "date": "2014-02-04T14:38:36-08:00",
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "committer": {
+ "date": "2014-02-12T15:18:55-08:00",
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "message": "Create styles.css and updated README",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68",
+ "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68"
+ },
+ "comment_count": 8
+ },
+ "author": {
+ "login": "octocat",
+ "id": 583231,
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4",
+ "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4",
+ "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4"
+ }
+ ],
+ "repository": {
+ "id": 1300192,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky",
+ "name": "Spoon-Knife",
+ "full_name": "octocat/Spoon-Knife",
+ "owner": {
+ "login": "octocat",
+ "id": 583231,
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Spoon-Knife",
+ "description": "This repo is for demonstration purposes only.",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Spoon-Knife",
+ "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks",
+ "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams",
+ "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks",
+ "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events",
+ "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags",
+ "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages",
+ "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers",
+ "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors",
+ "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription",
+ "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges",
+ "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads",
+ "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}",
+ "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments"
+ },
+ "score": 1,
+ "node_id": "MDQ6VXNlcjU4MzIzMQ=="
+ }
+ ]
+ }
+ },
+ "issue-search-result-item-paginated": {
+ "value": {
+ "total_count": 280,
+ "incomplete_results": false,
+ "items": [
+ {
+ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132",
+ "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit",
+ "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}",
+ "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments",
+ "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events",
+ "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132",
+ "id": 35802,
+ "node_id": "MDU6SXNzdWUzNTgwMg==",
+ "number": 132,
+ "title": "Line Number Indexes Beyond 20 Not Displayed",
+ "user": {
+ "login": "Nick3C",
+ "id": 90254,
+ "node_id": "MDQ6VXNlcjkwMjU0",
+ "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Nick3C",
+ "html_url": "https://github.com/Nick3C",
+ "followers_url": "https://api.github.com/users/Nick3C/followers",
+ "following_url": "https://api.github.com/users/Nick3C/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions",
+ "organizations_url": "https://api.github.com/users/Nick3C/orgs",
+ "repos_url": "https://api.github.com/users/Nick3C/repos",
+ "events_url": "https://api.github.com/users/Nick3C/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Nick3C/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "labels": [
+ {
+ "id": 4,
+ "node_id": "MDU6TGFiZWw0",
+ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug",
+ "name": "bug",
+ "color": "ff0000"
+ }
+ ],
+ "state": "open",
+ "assignee": null,
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "comments": 15,
+ "created_at": "2009-07-12T20:10:41Z",
+ "updated_at": "2009-07-19T09:23:43Z",
+ "closed_at": null,
+ "pull_request": {
+ "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "body": "...",
+ "score": 1,
+ "locked": true,
+ "author_association": "COLLABORATOR",
+ "state_reason": "completed"
+ }
+ ]
+ }
+ },
+ "label-search-result-item-paginated": {
+ "value": {
+ "total_count": 2,
+ "incomplete_results": false,
+ "items": [
+ {
+ "id": 418327088,
+ "node_id": "MDU6TGFiZWw0MTgzMjcwODg=",
+ "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement",
+ "name": "enhancement",
+ "color": "84b6eb",
+ "default": true,
+ "description": "New feature or request.",
+ "score": 1
+ },
+ {
+ "id": 418327086,
+ "node_id": "MDU6TGFiZWw0MTgzMjcwODY=",
+ "url": "https://api.github.com/repos/octocat/linguist/labels/bug",
+ "name": "bug",
+ "color": "ee0701",
+ "default": true,
+ "description": "Something isn't working.",
+ "score": 1
+ }
+ ]
+ }
+ },
+ "repo-search-result-item-paginated": {
+ "value": {
+ "total_count": 40,
+ "incomplete_results": false,
+ "items": [
+ {
+ "id": 3081286,
+ "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2",
+ "name": "Tetris",
+ "full_name": "dtrupenn/Tetris",
+ "owner": {
+ "login": "dtrupenn",
+ "id": 872147,
+ "node_id": "MDQ6VXNlcjg3MjE0Nw==",
+ "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/dtrupenn",
+ "received_events_url": "https://api.github.com/users/dtrupenn/received_events",
+ "type": "User",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "site_admin": true
+ },
+ "private": false,
+ "html_url": "https://github.com/dtrupenn/Tetris",
+ "description": "A C implementation of Tetris using Pennsim through LC4",
+ "fork": false,
+ "url": "https://api.github.com/repos/dtrupenn/Tetris",
+ "created_at": "2012-01-01T00:31:50Z",
+ "updated_at": "2013-01-05T17:58:47Z",
+ "pushed_at": "2012-01-01T00:37:02Z",
+ "homepage": "https://github.com",
+ "size": 524,
+ "stargazers_count": 1,
+ "watchers_count": 1,
+ "language": "Assembly",
+ "forks_count": 0,
+ "open_issues_count": 0,
+ "master_branch": "master",
+ "default_branch": "master",
+ "score": 1,
+ "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}",
+ "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors",
+ "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments",
+ "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads",
+ "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events",
+ "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks",
+ "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}",
+ "git_url": "git:github.com/dtrupenn/Tetris.git",
+ "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}",
+ "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}",
+ "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages",
+ "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges",
+ "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}",
+ "ssh_url": "git@github.com:dtrupenn/Tetris.git",
+ "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers",
+ "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers",
+ "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription",
+ "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags",
+ "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams",
+ "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}",
+ "clone_url": "https://github.com/dtrupenn/Tetris.git",
+ "mirror_url": "git:git.example.com/dtrupenn/Tetris",
+ "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks",
+ "svn_url": "https://svn.github.com/dtrupenn/Tetris",
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1,
+ "has_issues": true,
+ "has_projects": true,
+ "has_pages": true,
+ "has_wiki": true,
+ "has_downloads": true,
+ "archived": true,
+ "disabled": true,
+ "visibility": "private",
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ }
+ }
+ ]
+ }
+ },
+ "topic-search-result-item-paginated": {
+ "value": {
+ "total_count": 6,
+ "incomplete_results": false,
+ "items": [
+ {
+ "name": "ruby",
+ "display_name": "Ruby",
+ "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.",
+ "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.",
+ "created_by": "Yukihiro Matsumoto",
+ "released": "December 21, 1995",
+ "created_at": "2016-11-28T22:03:59Z",
+ "updated_at": "2017-10-30T18:16:32Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "rails",
+ "display_name": "Rails",
+ "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.",
+ "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.",
+ "created_by": "David Heinemeier Hansson",
+ "released": "December 13 2005",
+ "created_at": "2016-12-09T17:03:50Z",
+ "updated_at": "2017-10-30T16:20:19Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "python",
+ "display_name": "Python",
+ "short_description": "Python is a dynamically typed programming language.",
+ "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.",
+ "created_by": "Guido van Rossum",
+ "released": "February 20, 1991",
+ "created_at": "2016-12-07T00:07:02Z",
+ "updated_at": "2017-10-27T22:45:43Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "jekyll",
+ "display_name": "Jekyll",
+ "short_description": "Jekyll is a simple, blog-aware static site generator.",
+ "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.",
+ "created_by": "Tom Preston-Werner",
+ "released": "2008",
+ "created_at": "2016-12-16T21:53:08Z",
+ "updated_at": "2017-10-27T19:00:24Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "sass",
+ "display_name": "Sass",
+ "short_description": "Sass is a stable extension to classic CSS.",
+ "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.",
+ "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein",
+ "released": "November 28, 2006",
+ "created_at": "2016-12-16T21:53:45Z",
+ "updated_at": "2018-01-16T16:30:40Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "homebrew",
+ "display_name": "Homebrew",
+ "short_description": "Homebrew is a package manager for macOS.",
+ "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.",
+ "created_by": "Max Howell",
+ "released": "2009",
+ "created_at": "2016-12-17T20:30:44Z",
+ "updated_at": "2018-02-06T16:14:56Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ }
+ ]
+ }
+ },
+ "user-search-result-item-paginated": {
+ "value": {
+ "total_count": 12,
+ "incomplete_results": false,
+ "items": [
+ {
+ "login": "mojombo",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/mojombo",
+ "html_url": "https://github.com/mojombo",
+ "followers_url": "https://api.github.com/users/mojombo/followers",
+ "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
+ "organizations_url": "https://api.github.com/users/mojombo/orgs",
+ "repos_url": "https://api.github.com/users/mojombo/repos",
+ "received_events_url": "https://api.github.com/users/mojombo/received_events",
+ "type": "User",
+ "score": 1,
+ "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
+ "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
+ "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
+ "site_admin": true
+ }
+ ]
+ }
+ },
+ "team-repository-alternative-response-with-extra-repository-information": {
+ "value": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "maintain": false,
+ "push": false,
+ "triage": false,
+ "pull": true
+ },
+ "role_name": "read",
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "private-user-response-with-public-and-private-profile-information": {
+ "summary": "Response with public and private profile information",
+ "value": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "name": "monalisa octocat",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "hireable": false,
+ "bio": "There once was...",
+ "twitter_username": "monatheoctocat",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z",
+ "private_gists": 81,
+ "total_private_repos": 100,
+ "owned_private_repos": 100,
+ "disk_usage": 10000,
+ "collaborators": 8,
+ "two_factor_authentication": true,
+ "plan": {
+ "name": "Medium",
+ "space": 400,
+ "private_repos": 20,
+ "collaborators": 0
+ }
+ }
+ },
+ "private-user-response-with-public-profile-information": {
+ "summary": "Response with public profile information",
+ "value": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "name": "monalisa octocat",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "hireable": false,
+ "bio": "There once was...",
+ "twitter_username": "monatheoctocat",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z"
+ }
+ },
+ "private-user": {
+ "value": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "name": "monalisa octocat",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "hireable": false,
+ "bio": "There once was...",
+ "twitter_username": "monatheoctocat",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z",
+ "private_gists": 81,
+ "total_private_repos": 100,
+ "owned_private_repos": 100,
+ "disk_usage": 10000,
+ "collaborators": 8,
+ "two_factor_authentication": true,
+ "plan": {
+ "name": "Medium",
+ "space": 400,
+ "private_repos": 20,
+ "collaborators": 0
+ }
+ }
+ },
+ "codespaces-user-public-key": {
+ "value": {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+ }
+ },
+ "user-codespaces-secret": {
+ "value": {
+ "name": "CODESPACE_GH_SECRET",
+ "created_at": "2019-08-10T14:59:22Z",
+ "updated_at": "2020-01-10T14:59:22Z",
+ "visibility": "selected",
+ "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories"
+ }
+ },
+ "minimal-repository-paginated": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "organization": null,
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "delete_branch_on_merge": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ]
+ }
+ },
+ "user-export-details": {
+ "value": {
+ "state": "succeeded",
+ "completed_at": "2022-01-01T14:59:22Z",
+ "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q",
+ "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2",
+ "id": "latest",
+ "export_url": "https://api.github.com/user/codespaces/:name/exports/latest"
+ }
+ },
+ "codespace-with-full-repository": {
+ "value": {
+ "id": 1,
+ "name": "monalisa-octocat-hello-world-g4wpq6h95q",
+ "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "billable_owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "language": null,
+ "forks_count": 9,
+ "forks": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "open_issues": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "pull": true,
+ "push": false,
+ "admin": false
+ },
+ "allow_rebase_merge": true,
+ "template_repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World-Template",
+ "full_name": "octocat/Hello-World-Template",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World-Template",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World-Template",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World-Template.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World-Template.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World-Template.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World-Template",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World-Template",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks": 9,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "watchers": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues": 0,
+ "open_issues_count": 0,
+ "is_template": true,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0
+ },
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "allow_forking": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "organization": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "parent": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ },
+ "source": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ },
+ "machine": {
+ "name": "standardLinux",
+ "display_name": "4 cores, 16 GB RAM, 64 GB storage",
+ "operating_system": "linux",
+ "storage_in_bytes": 68719476736,
+ "memory_in_bytes": 17179869184,
+ "cpus": 4
+ },
+ "prebuild": false,
+ "devcontainer_path": ".devcontainer/devcontainer.json",
+ "created_at": "2021-10-14T00:53:30-06:00",
+ "updated_at": "2021-10-14T00:53:32-06:00",
+ "last_used_at": "2021-10-14T00:53:30-06:00",
+ "state": "Available",
+ "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q",
+ "git_status": {
+ "ahead": 0,
+ "behind": 0,
+ "has_unpushed_changes": false,
+ "has_uncommitted_changes": false,
+ "ref": "main"
+ },
+ "location": "WestUs2",
+ "idle_timeout_minutes": 60,
+ "retention_period_minutes": 43200,
+ "retention_expires_at": null,
+ "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
+ "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
+ "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
+ "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
+ "recent_folders": [
+
+ ],
+ "template": null
+ }
+ },
+ "packages-for-user": {
+ "value": [
+ {
+ "id": 197,
+ "name": "hello_docker",
+ "package_type": "container",
+ "owner": {
+ "login": "octocat",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "version_count": 1,
+ "visibility": "private",
+ "url": "https://api.github.com/orgs/github/packages/container/hello_docker",
+ "created_at": "2020-05-19T22:19:11Z",
+ "updated_at": "2020-05-19T22:19:11Z",
+ "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker"
+ },
+ {
+ "id": 198,
+ "name": "goodbye_docker",
+ "package_type": "container",
+ "owner": {
+ "login": "github",
+ "id": 9919,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/users/github/repos",
+ "events_url": "https://api.github.com/users/github/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "version_count": 2,
+ "visibility": "private",
+ "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker",
+ "created_at": "2020-05-20T22:19:11Z",
+ "updated_at": "2020-05-20T22:19:11Z",
+ "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker"
+ }
+ ]
+ },
+ "email-items-3": {
+ "value": [
+ {
+ "email": "octocat@github.com",
+ "primary": true,
+ "verified": true,
+ "visibility": "private"
+ }
+ ]
+ },
+ "email-items-2": {
+ "value": [
+ {
+ "email": "octocat@github.com",
+ "verified": true,
+ "primary": true,
+ "visibility": "public"
+ }
+ ]
+ },
+ "email-items": {
+ "value": [
+ {
+ "email": "octocat@octocat.org",
+ "primary": false,
+ "verified": false,
+ "visibility": "public"
+ },
+ {
+ "email": "octocat@github.com",
+ "primary": false,
+ "verified": false,
+ "visibility": null
+ },
+ {
+ "email": "mona@github.com",
+ "primary": false,
+ "verified": false,
+ "visibility": null
+ }
+ ]
+ },
+ "gpg-key-items": {
+ "value": [
+ {
+ "id": 3,
+ "name": "Octocat's GPG Key",
+ "primary_key_id": 2,
+ "key_id": "3262EFF25BA0D270",
+ "public_key": "xsBNBFayYZ...",
+ "emails": [
+ {
+ "email": "octocat@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "subkeys": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": "2016-03-24T11:31:04-07:00",
+ "revoked": false
+ }
+ ],
+ "can_sign": true,
+ "can_encrypt_comms": false,
+ "can_encrypt_storage": false,
+ "can_certify": true,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": "2016-03-24T11:31:04-07:00",
+ "revoked": false,
+ "raw_key": "string"
+ }
+ ]
+ },
+ "gpg-key": {
+ "value": {
+ "id": 3,
+ "name": "Octocat's GPG Key",
+ "primary_key_id": 2,
+ "key_id": "3262EFF25BA0D270",
+ "public_key": "xsBNBFayYZ...",
+ "emails": [
+ {
+ "email": "octocat@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "subkeys": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": "2016-03-24T11:31:04-07:00",
+ "revoked": false
+ }
+ ],
+ "can_sign": true,
+ "can_encrypt_comms": false,
+ "can_encrypt_storage": false,
+ "can_certify": true,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": "2016-03-24T11:31:04-07:00",
+ "revoked": false,
+ "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\""
+ }
+ },
+ "base-installation-for-auth-user-paginated": {
+ "value": {
+ "total_count": 2,
+ "installations": [
+ {
+ "id": 1,
+ "account": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "single_file_name": "config.yaml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "repository_selection": "all",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ },
+ {
+ "id": 3,
+ "account": {
+ "login": "octocat",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "single_file_name": "config.yaml",
+ "has_multiple_single_files": true,
+ "single_file_paths": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ],
+ "repository_selection": "all",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "app_slug": "github-actions",
+ "suspended_at": null,
+ "suspended_by": null
+ }
+ ]
+ }
+ },
+ "interaction-limit-user": {
+ "value": {
+ "limit": "collaborators_only",
+ "origin": "user",
+ "expires_at": "2018-08-17T04:18:39Z"
+ }
+ },
+ "key-items": {
+ "value": [
+ {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "id": 2,
+ "url": "https://api.github.com/user/keys/2",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "created_at": "2020-06-11T21:31:57Z",
+ "verified": false,
+ "read_only": false
+ },
+ {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
+ "id": 3,
+ "url": "https://api.github.com/user/keys/3",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
+ "created_at": "2020-07-11T21:31:57Z",
+ "verified": false,
+ "read_only": false
+ }
+ ]
+ },
+ "key": {
+ "value": {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "id": 2,
+ "url": "https://api.github.com/user/keys/2",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "created_at": "2020-06-11T21:31:57Z",
+ "verified": false,
+ "read_only": false
+ }
+ },
+ "user-marketplace-purchase-items": {
+ "value": [
+ {
+ "billing_cycle": "monthly",
+ "next_billing_date": "2017-11-11T00:00:00Z",
+ "unit_count": null,
+ "on_free_trial": true,
+ "free_trial_ends_on": "2017-11-11T00:00:00Z",
+ "updated_at": "2017-11-02T01:12:12Z",
+ "account": {
+ "login": "github",
+ "id": 4,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "email": null,
+ "organization_billing_email": "billing@github.com",
+ "type": "Organization"
+ },
+ "plan": {
+ "url": "https://api.github.com/marketplace_listing/plans/1313",
+ "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
+ "id": 1313,
+ "number": 3,
+ "name": "Pro",
+ "description": "A professional-grade CI solution",
+ "monthly_price_in_cents": 1099,
+ "yearly_price_in_cents": 11870,
+ "price_model": "FLAT_RATE",
+ "has_free_trial": true,
+ "unit_name": null,
+ "state": "published",
+ "bullets": [
+ "Up to 25 private repositories",
+ "11 concurrent builds"
+ ]
+ }
+ }
+ ]
+ },
+ "org-membership-items": {
+ "value": [
+ {
+ "url": "https://api.github.com/orgs/octocat/memberships/defunkt",
+ "state": "active",
+ "role": "admin",
+ "organization_url": "https://api.github.com/orgs/octocat",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ },
+ {
+ "url": "https://api.github.com/orgs/invitocat/memberships/defunkt",
+ "state": "pending",
+ "role": "admin",
+ "organization_url": "https://api.github.com/orgs/invitocat",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ ]
+ },
+ "org-membership": {
+ "value": {
+ "url": "https://api.github.com/orgs/invitocat/memberships/defunkt",
+ "state": "pending",
+ "role": "admin",
+ "organization_url": "https://api.github.com/orgs/invitocat",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "org-membership-2": {
+ "value": {
+ "url": "https://api.github.com/orgs/octocat/memberships/defunkt",
+ "state": "active",
+ "role": "admin",
+ "organization_url": "https://api.github.com/orgs/octocat",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization"
+ },
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "migration-items": {
+ "value": [
+ {
+ "id": 79,
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "pending",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ]
+ },
+ "migration-2": {
+ "value": {
+ "id": 79,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "pending",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00"
+ }
+ },
+ "migration": {
+ "value": {
+ "id": 79,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+ "state": "exported",
+ "lock_repositories": true,
+ "exclude_attachments": false,
+ "exclude_releases": false,
+ "exclude_owner_projects": false,
+ "org_metadata_only": false,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ],
+ "url": "https://api.github.com/orgs/octo-org/migrations/79",
+ "created_at": "2015-07-06T15:33:38-07:00",
+ "updated_at": "2015-07-06T15:33:38-07:00"
+ }
+ },
+ "package-user": {
+ "value": {
+ "id": 40201,
+ "name": "octo-name",
+ "package_type": "rubygems",
+ "owner": {
+ "login": "octocat",
+ "id": 209477,
+ "node_id": "MDQ6VXNlcjIwOTQ3Nw==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "version_count": 3,
+ "visibility": "public",
+ "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name",
+ "created_at": "2019-10-20T14:17:14Z",
+ "updated_at": "2019-10-20T14:17:14Z",
+ "repository": {
+ "id": 216219492,
+ "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=",
+ "name": "octo-name-repo",
+ "full_name": "octocat/octo-name-repo",
+ "private": false,
+ "owner": {
+ "login": "octocat",
+ "id": 209477,
+ "node_id": "MDQ6VXNlcjIwOTQ3Nw==",
+ "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "html_url": "https://github.com/octocat/octo-name-repo",
+ "description": "Project for octocats",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/octo-name-repo",
+ "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks",
+ "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams",
+ "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks",
+ "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events",
+ "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags",
+ "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages",
+ "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers",
+ "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors",
+ "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription",
+ "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges",
+ "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads",
+ "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}",
+ "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments"
+ },
+ "html_url": "https://github.com/octocat/octo-name-repo/packages/40201"
+ }
+ },
+ "package-versions-for-authenticated-user": {
+ "value": [
+ {
+ "id": 45763,
+ "name": "sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9",
+ "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763",
+ "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker",
+ "created_at": "2020-09-11T21:56:40Z",
+ "updated_at": "2021-02-05T21:32:32Z",
+ "html_url": "https://github.com/users/octocat/packages/container/hello_docker/45763",
+ "metadata": {
+ "package_type": "container",
+ "container": {
+ "tags": [
+ "latest"
+ ]
+ }
+ }
+ },
+ {
+ "id": 881,
+ "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344",
+ "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/881",
+ "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker",
+ "created_at": "2020-05-21T22:22:20Z",
+ "updated_at": "2021-02-05T21:32:32Z",
+ "html_url": "https://github.com/users/octocat/packages/container/hello_docker/881",
+ "metadata": {
+ "package_type": "container",
+ "container": {
+ "tags": [
+
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "package-version-authenticated-user": {
+ "value": {
+ "id": 214,
+ "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a",
+ "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214",
+ "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker",
+ "created_at": "2020-05-15T03:46:45Z",
+ "updated_at": "2020-05-15T03:46:45Z",
+ "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214",
+ "metadata": {
+ "package_type": "container",
+ "container": {
+ "tags": [
+ "1.13.6"
+ ]
+ }
+ }
+ }
+ },
+ "project": {
+ "value": {
+ "owner_url": "https://api.github.com/users/octocat",
+ "url": "https://api.github.com/projects/1002603",
+ "html_url": "https://github.com/users/octocat/projects/1",
+ "columns_url": "https://api.github.com/projects/1002603/columns",
+ "id": 1002603,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDM=",
+ "name": "My Projects",
+ "body": "A board to manage my personal projects.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z"
+ }
+ },
+ "repository-items-default-response": {
+ "summary": "Default response",
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ ]
+ },
+ "social-account-items": {
+ "value": [
+ {
+ "provider": "twitter",
+ "url": "https://twitter.com/github"
+ }
+ ]
+ },
+ "ssh-signing-key-items": {
+ "value": [
+ {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "id": 2,
+ "url": "https://api.github.com/user/keys/2",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "created_at": "2020-06-11T21:31:57Z"
+ },
+ {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
+ "id": 3,
+ "url": "https://api.github.com/user/keys/3",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
+ "created_at": "2020-07-11T21:31:57Z"
+ }
+ ]
+ },
+ "ssh-signing-key": {
+ "value": {
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "id": 2,
+ "url": "https://api.github.com/user/keys/2",
+ "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "created_at": "2020-06-11T21:31:57Z"
+ }
+ },
+ "starred-repository-items-alternative-response-with-star-creation-timestamps": {
+ "summary": "Alternative response with star creation timestamps",
+ "value": [
+ {
+ "starred_at": "2011-01-16T19:06:43Z",
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
+ }
+ }
+ ]
+ },
+ "team-full-items": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null,
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "is_verified": true,
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ ]
+ },
+ "public-user-default-response": {
+ "summary": "Default response",
+ "value": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "name": "monalisa octocat",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "hireable": false,
+ "bio": "There once was...",
+ "twitter_username": "monatheoctocat",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z"
+ }
+ },
+ "public-user-response-with-git-hub-plan-information": {
+ "summary": "Response with GitHub plan information",
+ "value": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false,
+ "name": "monalisa octocat",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "hireable": false,
+ "bio": "There once was...",
+ "twitter_username": "monatheoctocat",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z",
+ "plan": {
+ "name": "pro",
+ "space": 976562499,
+ "collaborators": 0,
+ "private_repos": 9999
+ }
+ }
+ },
+ "user-events-items": {
+ "value": [
+ {
+ "id": "22249084947",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": false,
+ "created_at": "2022-06-07T07:50:26Z"
+ }
+ ]
+ },
+ "user-org-events-items": {
+ "value": [
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": false,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22196946742",
+ "type": "CreateEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "ref": null,
+ "ref_type": "repository",
+ "master_branch": "master",
+ "description": null,
+ "pusher_type": "user"
+ },
+ "public": false,
+ "created_at": "2022-06-07T07:50:26Z",
+ "org": {
+ "id": 9919,
+ "login": "github",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
+ }
+ }
+ ]
+ },
+ "user-public-events-items": {
+ "value": [
+ {
+ "id": "22249084947",
+ "type": "WatchEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "action": "started"
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-08T23:29:25Z"
+ }
+ ]
+ },
+ "hovercard": {
+ "value": {
+ "contexts": [
+ {
+ "message": "Owns this repository",
+ "octicon": "repo"
+ }
+ ]
+ }
+ },
+ "key-simple-items": {
+ "value": [
+ {
+ "id": 1,
+ "key": "ssh-rsa AAA..."
+ }
+ ]
+ },
+ "package-versions-for-user": {
+ "value": [
+ {
+ "id": 3497268,
+ "name": "0.3.0",
+ "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268",
+ "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201",
+ "license": "MIT",
+ "created_at": "2020-08-31T15:22:11Z",
+ "updated_at": "2020-08-31T15:22:12Z",
+ "description": "Project for octocats",
+ "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0",
+ "metadata": {
+ "package_type": "rubygems"
+ }
+ },
+ {
+ "id": 387039,
+ "name": "0.2.0",
+ "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039",
+ "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201",
+ "license": "MIT",
+ "created_at": "2019-12-01T20:49:29Z",
+ "updated_at": "2019-12-01T20:49:30Z",
+ "description": "Project for octocats",
+ "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0",
+ "metadata": {
+ "package_type": "rubygems"
+ }
+ },
+ {
+ "id": 169770,
+ "name": "0.1.0",
+ "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770",
+ "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201",
+ "license": "MIT",
+ "created_at": "2019-10-20T14:17:14Z",
+ "updated_at": "2019-10-20T14:17:15Z",
+ "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0",
+ "metadata": {
+ "package_type": "rubygems"
+ }
+ }
+ ]
+ },
+ "package-version-user": {
+ "value": {
+ "id": 387039,
+ "name": "0.2.0",
+ "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039",
+ "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201",
+ "license": "MIT",
+ "created_at": "2019-12-01T20:49:29Z",
+ "updated_at": "2019-12-01T20:49:30Z",
+ "description": "Octo-name client for Ruby",
+ "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0",
+ "metadata": {
+ "package_type": "rubygems"
+ }
+ }
+ },
+ "project-items-3": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/users/octocat",
+ "url": "https://api.github.com/projects/1002603",
+ "html_url": "https://github.com/users/octocat/projects/1",
+ "columns_url": "https://api.github.com/projects/1002603/columns",
+ "id": 1002603,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDM=",
+ "name": "My Projects",
+ "body": "A board to manage my personal projects.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z"
+ }
+ ]
+ },
+ "user-received-events-items": {
+ "value": [
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22196946742",
+ "type": "CreateEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "ref": null,
+ "ref_type": "repository",
+ "master_branch": "master",
+ "description": null,
+ "pusher_type": "user"
+ },
+ "public": false,
+ "created_at": "2022-06-07T07:50:26Z",
+ "org": {
+ "id": 9919,
+ "login": "github",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
+ }
+ }
+ ]
+ },
+ "user-received-public-events-items": {
+ "value": [
+ {
+ "id": "22249084964",
+ "type": "PushEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "push_id": 10115855396,
+ "size": 1,
+ "distinct_size": 1,
+ "ref": "refs/heads/master",
+ "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "before": "883efe034920928c47fe18598c01249d1a9fdabd",
+ "commits": [
+ {
+ "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
+ "author": {
+ "email": "octocat@github.com",
+ "name": "Monalisa Octocat"
+ },
+ "message": "commit",
+ "distinct": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
+ }
+ ]
+ },
+ "public": true,
+ "created_at": "2022-06-09T12:47:28Z"
+ },
+ {
+ "id": "22196946742",
+ "type": "CreateEvent",
+ "actor": {
+ "id": 583231,
+ "login": "octocat",
+ "display_login": "octocat",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
+ },
+ "repo": {
+ "id": 1296269,
+ "name": "octocat/Hello-World",
+ "url": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "payload": {
+ "ref": null,
+ "ref_type": "repository",
+ "master_branch": "master",
+ "description": null,
+ "pusher_type": "user"
+ },
+ "public": false,
+ "created_at": "2022-06-07T07:50:26Z",
+ "org": {
+ "id": 9919,
+ "login": "github",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "avatar_url": "https://avatars.githubusercontent.com/u/9919?"
+ }
+ }
+ ]
+ },
+ "check-run-completed": {
+ "value": {
+ "action": "completed",
+ "check_run": {
+ "id": 128620228,
+ "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "external_id": "",
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
+ "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228",
+ "details_url": "https://octocoders.github.io",
+ "status": "completed",
+ "conclusion": "success",
+ "started_at": "2019-05-15T15:21:12Z",
+ "completed_at": "2019-05-15T15:21:45Z",
+ "output": {
+ "title": null,
+ "summary": null,
+ "text": null,
+ "annotations_count": 0,
+ "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"
+ },
+ "name": "Octocoders-linter",
+ "check_suite": {
+ "id": 118578147,
+ "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
+ "head_branch": "changes",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "status": "completed",
+ "conclusion": null,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
+ "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
+ "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ],
+ "deployment": {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+ "id": 326191728,
+ "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+ "task": "deploy",
+ "original_environment": "lab",
+ "environment": "lab",
+ "description": null,
+ "created_at": "2021-02-18T08:22:48Z",
+ "updated_at": "2021-02-18T09:47:16Z",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+ "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "created_at": "2019-05-15T15:20:31Z",
+ "updated_at": "2019-05-15T15:20:31Z"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "id": 186853002,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+ "name": "Hello-World",
+ "full_name": "Codertocat/Hello-World",
+ "private": false,
+ "owner": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/Codertocat/Hello-World",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
+ "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
+ "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
+ "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
+ "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
+ "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
+ "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
+ "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
+ "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
+ "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
+ "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
+ "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
+ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
+ "created_at": "2019-05-15T15:19:25Z",
+ "updated_at": "2019-05-15T15:21:03Z",
+ "pushed_at": "2019-05-15T15:20:57Z",
+ "git_url": "git://github.com/Codertocat/Hello-World.git",
+ "ssh_url": "git@github.com:Codertocat/Hello-World.git",
+ "clone_url": "https://github.com/Codertocat/Hello-World.git",
+ "svn_url": "https://github.com/Codertocat/Hello-World",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": true,
+ "forks_count": 1,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 2,
+ "license": null,
+ "forks": 1,
+ "open_issues": 2,
+ "watchers": 0,
+ "default_branch": "master",
+ "is_template": false
+ },
+ "sender": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "check-run-completed-form-encoded": {
+ "value": {
+ "payload": "%7B%22action%22%3A%22completed%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D"
+ }
+ },
+ "check-run-created": {
+ "value": {
+ "action": "created",
+ "check_run": {
+ "id": 128620228,
+ "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "external_id": "",
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
+ "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228",
+ "details_url": "https://octocoders.github.io",
+ "status": "queued",
+ "conclusion": null,
+ "started_at": "2019-05-15T15:21:12Z",
+ "completed_at": null,
+ "output": {
+ "title": null,
+ "summary": null,
+ "text": null,
+ "annotations_count": 0,
+ "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"
+ },
+ "name": "Octocoders-linter",
+ "check_suite": {
+ "id": 118578147,
+ "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
+ "head_branch": "changes",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "status": "queued",
+ "conclusion": null,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
+ "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
+ "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ],
+ "deployment": {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+ "id": 326191728,
+ "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+ "task": "deploy",
+ "original_environment": "lab",
+ "environment": "lab",
+ "description": null,
+ "created_at": "2021-02-18T08:22:48Z",
+ "updated_at": "2021-02-18T09:47:16Z",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+ "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "created_at": "2019-05-15T15:20:31Z",
+ "updated_at": "2019-05-15T15:20:31Z"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "id": 186853002,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+ "name": "Hello-World",
+ "full_name": "Codertocat/Hello-World",
+ "private": false,
+ "owner": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/Codertocat/Hello-World",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
+ "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
+ "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
+ "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
+ "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
+ "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
+ "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
+ "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
+ "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
+ "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
+ "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
+ "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
+ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
+ "created_at": "2019-05-15T15:19:25Z",
+ "updated_at": "2019-05-15T15:21:03Z",
+ "pushed_at": "2019-05-15T15:20:57Z",
+ "git_url": "git://github.com/Codertocat/Hello-World.git",
+ "ssh_url": "git@github.com:Codertocat/Hello-World.git",
+ "clone_url": "https://github.com/Codertocat/Hello-World.git",
+ "svn_url": "https://github.com/Codertocat/Hello-World",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": true,
+ "forks_count": 1,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 2,
+ "license": null,
+ "forks": 1,
+ "open_issues": 2,
+ "watchers": 0,
+ "default_branch": "master",
+ "is_template": false
+ },
+ "sender": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "check-run-created-form-encoded": {
+ "value": {
+ "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D"
+ }
+ },
+ "check-run-requested-action": {
+ "value": {
+ "action": "requested_action",
+ "check_run": {
+ "id": 128620228,
+ "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "external_id": "",
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
+ "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228",
+ "details_url": "https://octocoders.github.io",
+ "status": "queued",
+ "conclusion": null,
+ "started_at": "2019-05-15T15:21:12Z",
+ "completed_at": null,
+ "output": {
+ "title": null,
+ "summary": null,
+ "text": null,
+ "annotations_count": 0,
+ "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"
+ },
+ "name": "Octocoders-linter",
+ "check_suite": {
+ "id": 118578147,
+ "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
+ "head_branch": "changes",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "status": "queued",
+ "conclusion": null,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
+ "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
+ "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ],
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "created_at": "2019-05-15T15:20:31Z",
+ "updated_at": "2019-05-15T15:20:31Z"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ],
+ "deployment": {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+ "id": 326191728,
+ "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+ "task": "deploy",
+ "original_environment": "lab",
+ "environment": "lab",
+ "description": null,
+ "created_at": "2021-02-18T08:22:48Z",
+ "updated_at": "2021-02-18T09:47:16Z",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+ "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+ }
+ },
+ "requested_action": {
+ "identifier": "lgtm|1234"
+ },
+ "repository": {
+ "id": 186853002,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+ "name": "Hello-World",
+ "full_name": "Codertocat/Hello-World",
+ "private": false,
+ "owner": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/Codertocat/Hello-World",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
+ "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
+ "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
+ "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
+ "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
+ "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
+ "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
+ "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
+ "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
+ "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
+ "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
+ "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
+ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
+ "created_at": "2019-05-15T15:19:25Z",
+ "updated_at": "2019-05-15T15:21:03Z",
+ "pushed_at": "2019-05-15T15:20:57Z",
+ "git_url": "git://github.com/Codertocat/Hello-World.git",
+ "ssh_url": "git@github.com:Codertocat/Hello-World.git",
+ "clone_url": "https://github.com/Codertocat/Hello-World.git",
+ "svn_url": "https://github.com/Codertocat/Hello-World",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": true,
+ "forks_count": 1,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 2,
+ "license": null,
+ "forks": 1,
+ "open_issues": 2,
+ "watchers": 0,
+ "default_branch": "master"
+ },
+ "sender": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "check-run-requested-action-form-encoded": {
+ "value": {
+ "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D"
+ }
+ },
+ "check-run-rerequested": {
+ "value": {
+ "action": "rerequested",
+ "check_run": {
+ "id": 128620228,
+ "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "external_id": "",
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
+ "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228",
+ "details_url": "https://octocoders.github.io",
+ "status": "completed",
+ "conclusion": "success",
+ "started_at": "2019-05-15T15:21:12Z",
+ "completed_at": "2019-05-15T15:21:45Z",
+ "output": {
+ "title": null,
+ "summary": null,
+ "text": null,
+ "annotations_count": 0,
+ "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"
+ },
+ "name": "Octocoders-linter",
+ "check_suite": {
+ "id": 118578147,
+ "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
+ "head_branch": "changes",
+ "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "status": "completed",
+ "conclusion": null,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
+ "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
+ "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ],
+ "deployment": {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728",
+ "id": 326191728,
+ "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=",
+ "task": "deploy",
+ "original_environment": "lab",
+ "environment": "lab",
+ "description": null,
+ "created_at": "2021-02-18T08:22:48Z",
+ "updated_at": "2021-02-18T09:47:16Z",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses",
+ "repository_url": "https://api.github.com/repos/Codertocat/Hello-World"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "created_at": "2019-05-15T15:20:31Z",
+ "updated_at": "2019-05-15T15:20:31Z"
+ },
+ "app": {
+ "id": 29310,
+ "node_id": "MDM6QXBwMjkzMTA=",
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "name": "octocoders-linter",
+ "description": "",
+ "external_url": "https://octocoders.github.io",
+ "html_url": "https://github.com/apps/octocoders-linter",
+ "created_at": "2019-04-19T19:36:24Z",
+ "updated_at": "2019-04-19T19:36:56Z",
+ "permissions": {
+ "administration": "write",
+ "checks": "write",
+ "contents": "write",
+ "deployments": "write",
+ "issues": "write",
+ "members": "write",
+ "metadata": "read",
+ "organization_administration": "write",
+ "organization_hooks": "write",
+ "organization_plan": "read",
+ "organization_projects": "write",
+ "organization_user_blocking": "write",
+ "pages": "write",
+ "pull_requests": "write",
+ "repository_hooks": "write",
+ "repository_projects": "write",
+ "statuses": "write",
+ "team_discussions": "write",
+ "vulnerability_alerts": "read"
+ },
+ "events": [
+
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+ "id": 279147437,
+ "number": 2,
+ "head": {
+ "ref": "changes",
+ "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+ "repo": {
+ "id": 186853002,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "name": "Hello-World"
+ }
+ }
+ }
+ ]
+ },
+ "repository": {
+ "id": 186853002,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+ "name": "Hello-World",
+ "full_name": "Codertocat/Hello-World",
+ "private": false,
+ "owner": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/Codertocat/Hello-World",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/Codertocat/Hello-World",
+ "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
+ "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
+ "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
+ "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
+ "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
+ "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
+ "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
+ "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
+ "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
+ "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
+ "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
+ "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
+ "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
+ "created_at": "2019-05-15T15:19:25Z",
+ "updated_at": "2019-05-15T15:21:03Z",
+ "pushed_at": "2019-05-15T15:20:57Z",
+ "git_url": "git://github.com/Codertocat/Hello-World.git",
+ "ssh_url": "git@github.com:Codertocat/Hello-World.git",
+ "clone_url": "https://github.com/Codertocat/Hello-World.git",
+ "svn_url": "https://github.com/Codertocat/Hello-World",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": true,
+ "forks_count": 1,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 2,
+ "license": null,
+ "forks": 1,
+ "open_issues": 2,
+ "watchers": 0,
+ "default_branch": "master",
+ "is_template": false
+ },
+ "sender": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "check-run-rerequested-form-encoded": {
+ "value": {
+ "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D"
+ }
+ },
+ "ping": {
+ "value": {
+ "zen": "Anything added dilutes everything else.",
+ "hook_id": 109948940,
+ "hook": {
+ "type": "Repository",
+ "id": 109948940,
+ "name": "web",
+ "active": true,
+ "events": [
+ "*"
+ ],
+ "config": {
+ "content_type": "json",
+ "url": "https://smee.io/****************",
+ "insecure_ssl": "0"
+ },
+ "updated_at": "2019-05-15T15:20:49Z",
+ "created_at": "2019-05-15T15:20:49Z",
+ "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940",
+ "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test",
+ "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ },
+ "repository": {
+ "id": 186853261,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=",
+ "name": "Hello-World",
+ "full_name": "Octocoders/Hello-World",
+ "private": false,
+ "owner": {
+ "login": "Octocoders",
+ "id": 38302899,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Octocoders",
+ "html_url": "https://github.com/Octocoders",
+ "followers_url": "https://api.github.com/users/Octocoders/followers",
+ "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+ "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+ "repos_url": "https://api.github.com/users/Octocoders/repos",
+ "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/Octocoders/Hello-World",
+ "description": null,
+ "fork": true,
+ "url": "https://api.github.com/repos/Octocoders/Hello-World",
+ "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks",
+ "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams",
+ "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks",
+ "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events",
+ "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags",
+ "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages",
+ "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers",
+ "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors",
+ "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription",
+ "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges",
+ "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads",
+ "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}",
+ "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments",
+ "created_at": "2019-05-15T15:20:42Z",
+ "updated_at": "2019-05-15T15:20:45Z",
+ "pushed_at": "2019-05-15T15:20:33Z",
+ "git_url": "git://github.com/Octocoders/Hello-World.git",
+ "ssh_url": "git@github.com:Octocoders/Hello-World.git",
+ "clone_url": "https://github.com/Octocoders/Hello-World.git",
+ "svn_url": "https://github.com/Octocoders/Hello-World",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": false,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "forks_count": 0,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 0,
+ "license": null,
+ "forks": 0,
+ "open_issues": 0,
+ "watchers": 0,
+ "default_branch": "master"
+ },
+ "sender": {
+ "login": "Codertocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Codertocat",
+ "html_url": "https://github.com/Codertocat",
+ "followers_url": "https://api.github.com/users/Codertocat/followers",
+ "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+ "repos_url": "https://api.github.com/users/Codertocat/repos",
+ "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "ping-form-encoded": {
+ "value": {
+ "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D"
+ }
+ },
+ "secret-scanning-alert-location-created": {
+ "value": {
+ "action": "created",
+ "alert": {
+ "number": 42,
+ "created_at": "2020-11-06T18:18:30Z",
+ "updated_at": "2020-11-06T18:18:30Z",
+ "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42",
+ "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42",
+ "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations",
+ "state": "open",
+ "resolution": null,
+ "resolved_at": null,
+ "resolved_by": null,
+ "secret_type": "mailchimp_api_key",
+ "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2"
+ },
+ "location": {
+ "type": "commit",
+ "details": {
+ "path": "/example/secrets.txt",
+ "start_line": 1,
+ "end_line": 1,
+ "start_column": 1,
+ "end_column": 64,
+ "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
+ "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b",
+ "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b",
+ "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
+ }
+ },
+ "repository": {
+ "id": 186853002,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+ "name": "hello-world",
+ "full_name": "octocat-repo/hello-world",
+ "private": false,
+ "owner": {
+ "login": "octocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "html_url": "https://github.com/octocat-repo/hello-world",
+ "description": null,
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat-repo/hello-world",
+ "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks",
+ "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams",
+ "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks",
+ "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events",
+ "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags",
+ "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages",
+ "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers",
+ "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors",
+ "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription",
+ "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges",
+ "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads",
+ "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}",
+ "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments",
+ "created_at": "2019-05-15T15:19:25Z",
+ "updated_at": "2019-05-15T15:21:03Z",
+ "pushed_at": "2019-05-15T15:20:57Z",
+ "git_url": "git://github.com/octocat-repo/hello-world.git",
+ "ssh_url": "git@github.com:octocat-repo/hello-world.git",
+ "clone_url": "https://github.com/octocat-repo/hello-world.git",
+ "svn_url": "https://github.com/octocat-repo/hello-world",
+ "homepage": null,
+ "size": 0,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": "Ruby",
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": true,
+ "forks_count": 1,
+ "mirror_url": null,
+ "archived": false,
+ "disabled": false,
+ "open_issues_count": 2,
+ "license": null,
+ "forks": 1,
+ "open_issues": 2,
+ "watchers": 0,
+ "default_branch": "master",
+ "is_template": false
+ },
+ "sender": {
+ "login": "octocat",
+ "id": 21031067,
+ "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ },
+ "secret-scanning-alert-location-created-form-encoded": {
+ "value": {
+ "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A"
+ }
+ }
+ },
+ "parameters": {
+ "pagination-before": {
+ "name": "before",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "pagination-after": {
+ "name": "after",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "direction": {
+ "name": "direction",
+ "description": "The direction to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ "ghsa_id": {
+ "name": "ghsa_id",
+ "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "per-page": {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ "cursor": {
+ "name": "cursor",
+ "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "delivery-id": {
+ "name": "delivery_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "page": {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ "since": {
+ "name": "since",
+ "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "installation-id": {
+ "name": "installation_id",
+ "description": "The unique identifier of the installation.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "examples": {
+ "default": {
+ "value": 1
+ }
+ }
+ },
+ "client-id": {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "description": "The client ID of the GitHub app.",
+ "schema": {
+ "type": "string"
+ },
+ "examples": {
+ "default": {
+ "value": "Iv1.8a61f9b3a7aba766"
+ }
+ }
+ },
+ "app-slug": {
+ "name": "app_slug",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "assignment-id": {
+ "name": "assignment_id",
+ "description": "The unique identifier of the classroom assignment.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "classroom-id": {
+ "name": "classroom_id",
+ "description": "The unique identifier of the classroom.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "enterprise": {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-comma-separated-states": {
+ "name": "state",
+ "in": "query",
+ "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-comma-separated-severities": {
+ "name": "severity",
+ "in": "query",
+ "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-comma-separated-ecosystems": {
+ "name": "ecosystem",
+ "in": "query",
+ "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-comma-separated-packages": {
+ "name": "package",
+ "in": "query",
+ "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-scope": {
+ "name": "scope",
+ "in": "query",
+ "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "development",
+ "runtime"
+ ]
+ }
+ },
+ "dependabot-alert-sort": {
+ "name": "sort",
+ "in": "query",
+ "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ },
+ "pagination-first": {
+ "name": "first",
+ "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ "pagination-last": {
+ "name": "last",
+ "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100
+ }
+ },
+ "secret-scanning-alert-state": {
+ "name": "state",
+ "in": "query",
+ "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "resolved"
+ ]
+ }
+ },
+ "secret-scanning-alert-secret-type": {
+ "name": "secret_type",
+ "in": "query",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "secret-scanning-alert-resolution": {
+ "name": "resolution",
+ "in": "query",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "secret-scanning-alert-sort": {
+ "name": "sort",
+ "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ },
+ "secret-scanning-alert-validity": {
+ "name": "validity",
+ "in": "query",
+ "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "gist-id": {
+ "name": "gist_id",
+ "description": "The unique identifier of the gist.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "comment-id": {
+ "name": "comment_id",
+ "description": "The unique identifier of the comment.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "labels": {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "account-id": {
+ "name": "account_id",
+ "description": "account_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "plan-id": {
+ "name": "plan_id",
+ "description": "The unique identifier of the plan.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "sort": {
+ "name": "sort",
+ "description": "The property to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ },
+ "owner": {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "repo": {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "all": {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "participating": {
+ "name": "participating",
+ "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "before": {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "thread-id": {
+ "name": "thread_id",
+ "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "since-org": {
+ "name": "since",
+ "description": "An organization ID. Only return organizations with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "org": {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "repository-id": {
+ "name": "repository_id",
+ "description": "The unique identifier of the repository.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "runner-id": {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "runner-label-name": {
+ "name": "name",
+ "description": "The name of a self-hosted runner's custom label.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "secret-name": {
+ "name": "secret_name",
+ "description": "The name of the secret.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "variables-per-page": {
+ "name": "per_page",
+ "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 10
+ }
+ },
+ "variable-name": {
+ "name": "name",
+ "description": "The name of the variable.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "username": {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "tool-name": {
+ "name": "tool_name",
+ "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-name"
+ }
+ },
+ "tool-guid": {
+ "name": "tool_guid",
+ "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
+ }
+ },
+ "hook-id": {
+ "name": "hook_id",
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "invitation-id": {
+ "name": "invitation_id",
+ "description": "The unique identifier of the invitation.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "codespace-name": {
+ "name": "codespace_name",
+ "in": "path",
+ "required": true,
+ "description": "The name of the codespace.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "migration-id": {
+ "name": "migration_id",
+ "description": "The unique identifier of the migration.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "repo-name": {
+ "name": "repo_name",
+ "description": "repo_name parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "team-slug": {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "role-id": {
+ "name": "role_id",
+ "description": "The unique identifier of the role.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "package-visibility": {
+ "name": "visibility",
+ "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "public",
+ "private",
+ "internal"
+ ]
+ }
+ },
+ "package-type": {
+ "name": "package_type",
+ "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "npm",
+ "maven",
+ "rubygems",
+ "docker",
+ "nuget",
+ "container"
+ ]
+ }
+ },
+ "package-name": {
+ "name": "package_name",
+ "description": "The name of the package.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "package-version-id": {
+ "name": "package_version_id",
+ "description": "Unique identifier of the package version.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "personal-access-token-sort": {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created_at"
+ ],
+ "default": "created_at"
+ }
+ },
+ "personal-access-token-owner": {
+ "name": "owner",
+ "description": "A list of owner usernames to use to filter the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "type": "string"
+ },
+ "example": "owner[]=octocat1,owner[]=octocat2"
+ }
+ },
+ "personal-access-token-repository": {
+ "name": "repository",
+ "description": "The name of the repository to use to filter the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "example": "Hello-World"
+ }
+ },
+ "personal-access-token-permission": {
+ "name": "permission",
+ "description": "The permission to use to filter the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "example": "issues_read"
+ }
+ },
+ "personal-access-token-before": {
+ "name": "last_used_before",
+ "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "personal-access-token-after": {
+ "name": "last_used_after",
+ "description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "fine-grained-personal-access-token-id": {
+ "name": "pat_id",
+ "description": "The unique identifier of the fine-grained personal access token.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "custom-property-name": {
+ "name": "custom_property_name",
+ "description": "The custom property name. The name is case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "repository-name-in-query": {
+ "name": "repository_name",
+ "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.",
+ "in": "query",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "time-period": {
+ "name": "time_period",
+ "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "default": "day"
+ }
+ },
+ "actor-name-in-query": {
+ "name": "actor_name",
+ "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "rule-suite-result": {
+ "name": "rule_suite_result",
+ "description": "The rule results to filter on. When specified, only suites with this result will be returned.",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "pass",
+ "fail",
+ "bypass",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ "rule-suite-id": {
+ "name": "rule_suite_id",
+ "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "secret-scanning-pagination-before-org-repo": {
+ "name": "before",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "secret-scanning-pagination-after-org-repo": {
+ "name": "after",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "discussion-number": {
+ "name": "discussion_number",
+ "description": "The number that identifies the discussion.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "comment-number": {
+ "name": "comment_number",
+ "description": "The number that identifies the comment.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "reaction-id": {
+ "name": "reaction_id",
+ "description": "The unique identifier of the reaction.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "project-id": {
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "security-product": {
+ "name": "security_product",
+ "in": "path",
+ "description": "The security feature to enable or disable.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "dependency_graph",
+ "dependabot_alerts",
+ "dependabot_security_updates",
+ "advanced_security",
+ "code_scanning_default_setup",
+ "secret_scanning",
+ "secret_scanning_push_protection"
+ ]
+ }
+ },
+ "org-security-product-enablement": {
+ "name": "enablement",
+ "in": "path",
+ "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "enable_all",
+ "disable_all"
+ ]
+ }
+ },
+ "card-id": {
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "column-id": {
+ "name": "column_id",
+ "description": "The unique identifier of the column.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "artifact-name": {
+ "name": "name",
+ "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "artifact-id": {
+ "name": "artifact_id",
+ "description": "The unique identifier of the artifact.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "actions-cache-git-ref-full": {
+ "name": "ref",
+ "description": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "actions-cache-key": {
+ "name": "key",
+ "description": "An explicit key or prefix for identifying the cache",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "actions-cache-list-sort": {
+ "name": "sort",
+ "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created_at",
+ "last_accessed_at",
+ "size_in_bytes"
+ ],
+ "default": "last_accessed_at"
+ }
+ },
+ "actions-cache-key-required": {
+ "name": "key",
+ "description": "A key for identifying the cache.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "cache-id": {
+ "name": "cache_id",
+ "description": "The unique identifier of the GitHub Actions cache.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "job-id": {
+ "name": "job_id",
+ "description": "The unique identifier of the job.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "actor": {
+ "name": "actor",
+ "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "workflow-run-branch": {
+ "name": "branch",
+ "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "event": {
+ "name": "event",
+ "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "workflow-run-status": {
+ "name": "status",
+ "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "completed",
+ "action_required",
+ "cancelled",
+ "failure",
+ "neutral",
+ "skipped",
+ "stale",
+ "success",
+ "timed_out",
+ "in_progress",
+ "queued",
+ "requested",
+ "waiting",
+ "pending"
+ ]
+ }
+ },
+ "created": {
+ "name": "created",
+ "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "exclude-pull-requests": {
+ "name": "exclude_pull_requests",
+ "description": "If `true` pull requests are omitted from the response (empty array).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "workflow-run-check-suite-id": {
+ "name": "check_suite_id",
+ "description": "Returns workflow runs with the `check_suite_id` that you specify.",
+ "in": "query",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "workflow-run-head-sha": {
+ "name": "head_sha",
+ "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "run-id": {
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "attempt-number": {
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "workflow-id": {
+ "name": "workflow_id",
+ "in": "path",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "required": true,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "autolink-id": {
+ "name": "autolink_id",
+ "description": "The unique identifier of the autolink.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "branch": {
+ "name": "branch",
+ "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ "check-run-id": {
+ "name": "check_run_id",
+ "description": "The unique identifier of the check run.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "check-suite-id": {
+ "name": "check_suite_id",
+ "description": "The unique identifier of the check suite.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "check-name": {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "status": {
+ "name": "status",
+ "description": "Returns check runs with the specified `status`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ }
+ },
+ "git-ref": {
+ "name": "ref",
+ "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/code-scanning-ref"
+ }
+ },
+ "alert-number": {
+ "name": "alert_number",
+ "in": "path",
+ "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.",
+ "required": true,
+ "schema": {
+ "$ref": "#/components/schemas/alert-number"
+ }
+ },
+ "commit-sha": {
+ "name": "commit_sha",
+ "description": "The SHA of the commit.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ "commit-ref": {
+ "name": "ref",
+ "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ "dependabot-alert-comma-separated-manifests": {
+ "name": "manifest",
+ "in": "query",
+ "description": "A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "dependabot-alert-number": {
+ "name": "alert_number",
+ "in": "path",
+ "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.",
+ "required": true,
+ "schema": {
+ "$ref": "#/components/schemas/alert-number"
+ }
+ },
+ "manifest-path": {
+ "name": "name",
+ "description": "The full path, relative to the repository root, of the dependency manifest file.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "deployment-id": {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "environment-name": {
+ "name": "environment_name",
+ "in": "path",
+ "required": true,
+ "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "branch-policy-id": {
+ "name": "branch_policy_id",
+ "in": "path",
+ "required": true,
+ "description": "The unique identifier of the branch policy.",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "protection-rule-id": {
+ "name": "protection_rule_id",
+ "description": "The unique identifier of the protection rule.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "since-user": {
+ "name": "since",
+ "description": "A user ID. Only return users with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "issue-number": {
+ "name": "issue_number",
+ "description": "The number that identifies the issue.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "key-id": {
+ "name": "key_id",
+ "description": "The unique identifier of the key.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "milestone-number": {
+ "name": "milestone_number",
+ "description": "The number that identifies the milestone.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "pages-deployment-id": {
+ "name": "pages_deployment_id",
+ "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "oneOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "pull-number": {
+ "name": "pull_number",
+ "description": "The number that identifies the pull request.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "review-id": {
+ "name": "review_id",
+ "description": "The unique identifier of the review.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "asset-id": {
+ "name": "asset_id",
+ "description": "The unique identifier of the asset.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "release-id": {
+ "name": "release_id",
+ "description": "The unique identifier of the release.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "ref-in-query": {
+ "name": "ref",
+ "description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "x-multi-segment": true
+ },
+ "tag-protection-id": {
+ "name": "tag_protection_id",
+ "description": "The unique identifier of the tag protection.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "per": {
+ "name": "per",
+ "description": "The time frame to display results for.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "day",
+ "week"
+ ],
+ "default": "day"
+ }
+ },
+ "since-repo": {
+ "name": "since",
+ "description": "A repository ID. Only return repositories with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "order": {
+ "name": "order",
+ "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "desc",
+ "asc"
+ ],
+ "default": "desc"
+ }
+ },
+ "team-id": {
+ "name": "team_id",
+ "description": "The unique identifier of the team.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "repository-id-in-query": {
+ "name": "repository_id",
+ "description": "ID of the Repository to filter on",
+ "in": "query",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "export-id": {
+ "name": "export_id",
+ "in": "path",
+ "required": true,
+ "description": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "gpg-key-id": {
+ "name": "gpg_key_id",
+ "description": "The unique identifier of the GPG key.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "since-repo-date": {
+ "name": "since",
+ "description": "Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "before-repo-date": {
+ "name": "before",
+ "description": "Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "ssh-signing-key-id": {
+ "name": "ssh_signing_key_id",
+ "description": "The unique identifier of the SSH signing key.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "sort-starred": {
+ "name": "sort",
+ "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ],
+ "default": "created"
+ }
+ }
+ },
+ "responses": {
+ "validation_failed_simple": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/validation-error-simple"
+ }
+ }
+ }
+ },
+ "not_found": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "bad_request": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "$ref": "#/components/schemas/scim-error"
+ }
+ }
+ }
+ },
+ "validation_failed": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/validation-error"
+ }
+ }
+ }
+ },
+ "accepted": {
+ "description": "Accepted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "not_modified": {
+ "description": "Not modified"
+ },
+ "requires_authentication": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "forbidden": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "service_unavailable": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "forbidden_gist": {
+ "description": "Forbidden Gist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "block": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "moved_permanently": {
+ "description": "Moved permanently",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "conflict": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "actions_runner_jitconfig": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "runner",
+ "encoded_jit_config"
+ ],
+ "properties": {
+ "runner": {
+ "$ref": "#/components/schemas/runner"
+ },
+ "encoded_jit_config": {
+ "type": "string",
+ "description": "The base64 encoded runner configuration."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-jitconfig"
+ }
+ }
+ }
+ }
+ },
+ "actions_runner_labels": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "labels"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner-label"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-labels"
+ }
+ }
+ }
+ }
+ },
+ "actions_runner_labels_readonly": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "total_count",
+ "labels"
+ ],
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "labels": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/runner-label"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/runner-labels-readonly"
+ }
+ }
+ }
+ }
+ },
+ "internal_error": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "package_es_list_error": {
+ "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000."
+ },
+ "no_content": {
+ "description": "A header with no content is returned."
+ },
+ "gone": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "temporary_redirect": {
+ "description": "Temporary Redirect",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "code_scanning_forbidden_read": {
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "code_scanning_forbidden_write": {
+ "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "found": {
+ "description": "Found"
+ },
+ "code_scanning_conflict": {
+ "description": "Response if there is already a validation run in progress with a different default setup configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "dependency_review_forbidden": {
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "porter_maintenance": {
+ "description": "Unavailable due to service under maintenance.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "content-type": {
+ "example": "text/html",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-common-marker-version": {
+ "example": "0.17.4",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-rate-limit-limit": {
+ "example": 5000,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "x-rate-limit-remaining": {
+ "example": 4999,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "x-rate-limit-reset": {
+ "example": 1590701888,
+ "schema": {
+ "type": "integer",
+ "format": "timestamp"
+ }
+ },
+ "location": {
+ "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/modules/openapi-generator/src/test/resources/3_0/opendota.json b/modules/openapi-generator/src/test/resources/3_0/opendota.json
new file mode 100644
index 000000000000..3f59c3cb699b
--- /dev/null
+++ b/modules/openapi-generator/src/test/resources/3_0/opendota.json
@@ -0,0 +1 @@
+{"openapi":"3.0.3","info":{"title":"OpenDota API","description":"# Introduction\nThe OpenDota API provides Dota 2 related data including advanced match data extracted from match replays.\n\nYou can find data that can be used to convert hero and ability IDs and other information provided by the API from the [dotaconstants](https://github.com/odota/dotaconstants) repository.\n\n**Beginning 2018-04-22, the OpenDota API is limited to 50,000 free calls per month and 60 requests/minute** We offer a Premium Tier with unlimited API calls and higher rate limits. Check out the [API page](https://www.opendota.com/api-keys) to learn more.\n","version":"20.0.0"},"servers":[{"url":"https://api.opendota.com/api"}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api_key","description":"Use an API key to remove monthly call limits and to receive higher rate limits. [Learn more and get your API key](https://www.opendota.com/api-keys).\n Usage example: https://api.opendota.com/api/matches/271145478?api_key=YOUR-API-KEY\n \n API key can also be sent using the authorization header \"Authorization: Bearer YOUR-API-KEY\"\n ","in":"query"}},"schemas":{"MatchResponse":{"title":"MatchResponse","type":"object","properties":{"match_id":{"description":"The ID number of the match assigned by Valve","type":"integer"},"barracks_status_dire":{"description":"Bitmask. An integer that represents a binary of which barracks are still standing. 63 would mean all barracks still stand at the end of the game.","type":"integer"},"barracks_status_radiant":{"description":"Bitmask. An integer that represents a binary of which barracks are still standing. 63 would mean all barracks still stand at the end of the game.","type":"integer"},"chat":{"description":"Array containing information on the chat of the game","type":"array","items":{"type":"object","properties":{"time":{"description":"Time in seconds at which the message was said","type":"integer"},"unit":{"description":"Name of the player who sent the message","type":"string"},"key":{"description":"The message the player sent","type":"string"},"slot":{"description":"slot","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"}}}},"cluster":{"description":"cluster","type":"integer"},"cosmetics":{"description":"cosmetics","type":"object","additionalProperties":{"type":"integer"}},"dire_score":{"description":"Final score for Dire (number of kills on Radiant)","type":"integer"},"draft_timings":{"description":"draft_timings","type":"array","items":{"description":"draft_stage","type":"object","properties":{"order":{"description":"order","type":"integer"},"pick":{"description":"pick","type":"boolean"},"active_team":{"description":"active_team","type":"integer"},"hero_id":{"description":"The ID value of the hero played","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"},"extra_time":{"description":"extra_time","type":"integer"},"total_time_taken":{"description":"total_time_taken","type":"integer"}}}},"duration":{"description":"Duration of the game in seconds","type":"integer"},"engine":{"description":"engine","type":"integer"},"first_blood_time":{"description":"Time in seconds at which first blood occurred","type":"integer"},"game_mode":{"description":"Integer corresponding to game mode played. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/game_mode.json","type":"integer"},"human_players":{"description":"Number of human players in the game","type":"integer"},"leagueid":{"description":"leagueid","type":"integer"},"lobby_type":{"description":"Integer corresponding to lobby type of match. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/lobby_type.json","type":"integer"},"match_seq_num":{"description":"match_seq_num","type":"integer"},"negative_votes":{"description":"Number of negative votes the replay received in the in-game client","type":"integer"},"objectives":{"description":"objectives","type":"array","items":{"type":"object"}},"picks_bans":{"description":"Array containing information on the draft. Each item contains a boolean relating to whether the choice is a pick or a ban, the hero ID, the team the picked or banned it, and the order.","type":"array","items":{"type":"object","properties":{"is_pick":{"description":"Boolean indicating whether the choice is a pick or a ban","type":"boolean"},"hero_id":{"description":"The hero ID","type":"integer"},"team":{"description":"The team that picked or banned the hero","type":"integer"},"order":{"description":"The order of the pick or ban","type":"integer"}}}},"positive_votes":{"description":"Number of positive votes the replay received in the in-game client","type":"integer"},"radiant_gold_adv":{"description":"Array of the Radiant gold advantage at each minute in the game. A negative number means that Radiant is behind, and thus it is their gold disadvantage. ","type":"array","items":{"type":"number"}},"radiant_score":{"description":"Final score for Radiant (number of kills on Radiant)","type":"integer"},"radiant_win":{"description":"Boolean indicating whether Radiant won the match","type":"boolean"},"radiant_xp_adv":{"description":"Array of the Radiant experience advantage at each minute in the game. A negative number means that Radiant is behind, and thus it is their experience disadvantage. ","type":"array","items":{"type":"number"}},"start_time":{"description":"The Unix timestamp at which the game started","type":"integer"},"teamfights":{"description":"teamfights","type":"array","items":{"type":"array","items":{"type":"object"}}},"tower_status_dire":{"description":"Bitmask. An integer that represents a binary of which Dire towers are still standing.","type":"integer"},"tower_status_radiant":{"description":"Bitmask. An integer that represents a binary of which Radiant towers are still standing.","type":"integer"},"version":{"description":"Parse version, used internally by OpenDota","type":"integer"},"replay_salt":{"description":"replay_salt","type":"integer"},"series_id":{"description":"series_id","type":"integer"},"series_type":{"description":"series_type","type":"integer"},"radiant_team":{"description":"radiant_team","type":"object"},"dire_team":{"description":"dire_team","type":"object"},"league":{"description":"league","type":"object"},"skill":{"description":"Skill bracket assigned by Valve (Normal, High, Very High)","type":"integer"},"players":{"description":"Array of information on individual players","type":"array","items":{"description":"player","type":"object","properties":{"match_id":{"description":"Match ID","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"},"ability_upgrades_arr":{"description":"An array describing how abilities were upgraded","type":"array","items":{"type":"integer"}},"ability_uses":{"description":"Object containing information on how many times the played used their abilities","type":"object"},"ability_targets":{"description":"Object containing information on who the player used their abilities on","type":"object"},"damage_targets":{"description":"Object containing information on how and how much damage the player dealt to other heroes","type":"object"},"account_id":{"description":"account_id","type":"integer"},"actions":{"description":"Object containing information on how many and what type of actions the player issued to their hero","type":"object"},"additional_units":{"description":"Object containing information on additional units the player had under their control","type":"array","items":{"type":"object"},"nullable":true},"assists":{"description":"Number of assists the player had","type":"integer"},"backpack_0":{"description":"Item in backpack slot 0","type":"integer"},"backpack_1":{"description":"Item in backpack slot 1","type":"integer"},"backpack_2":{"description":"Item in backpack slot 2","type":"integer"},"buyback_log":{"description":"Array containing information about buybacks","type":"array","items":{"type":"object","properties":{"time":{"description":"Time in seconds the buyback occurred","type":"integer"},"slot":{"description":"slot","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"}}}},"camps_stacked":{"description":"Number of camps stacked","type":"integer"},"connection_log":{"description":"Array containing information about the player's disconnections and reconnections","type":"array","items":{"type":"object","properties":{"time":{"description":"Game time in seconds the event ocurred","type":"integer"},"event":{"description":"Event that occurred","type":"string"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"}}}},"creeps_stacked":{"description":"Number of creeps stacked","type":"integer"},"damage":{"description":"Object containing information about damage dealt by the player to different units","type":"object"},"damage_inflictor":{"description":"Object containing information about about the sources of this player's damage to heroes","type":"object"},"damage_inflictor_received":{"description":"Object containing information about the sources of damage received by this player from heroes","type":"object"},"damage_taken":{"description":"Object containing information about from whom the player took damage","type":"object"},"deaths":{"description":"Number of deaths","type":"integer"},"denies":{"description":"Number of denies","type":"integer"},"dn_t":{"description":"Array containing number of denies at different times of the match","type":"array","items":{"type":"integer"}},"gold":{"description":"Gold at the end of the game","type":"integer"},"gold_per_min":{"description":"Gold Per Minute obtained by this player","type":"integer"},"gold_reasons":{"description":"Object containing information on how the player gainined gold over the course of the match","type":"object"},"gold_spent":{"description":"How much gold the player spent","type":"integer"},"gold_t":{"description":"Array containing total gold at different times of the match","type":"array","items":{"type":"integer"}},"hero_damage":{"description":"Hero Damage Dealt","type":"integer"},"hero_healing":{"description":"Hero Healing Done","type":"integer"},"hero_hits":{"description":"Object containing information on how many ticks of damages the hero inflicted with different spells and damage inflictors","type":"object"},"hero_id":{"description":"The ID value of the hero played","type":"integer"},"item_0":{"description":"Item in the player's first slot","type":"integer"},"item_1":{"description":"Item in the player's second slot","type":"integer"},"item_2":{"description":"Item in the player's third slot","type":"integer"},"item_3":{"description":"Item in the player's fourth slot","type":"integer"},"item_4":{"description":"Item in the player's fifth slot","type":"integer"},"item_5":{"description":"Item in the player's sixth slot","type":"integer"},"item_uses":{"description":"Object containing information about how many times a player used items","type":"object"},"kill_streaks":{"description":"Object containing information about the player's killstreaks","type":"object"},"killed":{"description":"Object containing information about what units the player killed","type":"object"},"killed_by":{"description":"Object containing information about who killed the player","type":"object"},"kills":{"description":"Number of kills","type":"integer"},"kills_log":{"description":"Array containing information on which hero the player killed at what time","type":"array","items":{"type":"object","properties":{"time":{"description":"Time in seconds the player killed the hero","type":"integer"},"key":{"description":"Hero killed","type":"string"}}}},"lane_pos":{"description":"Object containing information on lane position","type":"object"},"last_hits":{"description":"Number of last hits","type":"integer"},"leaver_status":{"description":"Integer describing whether or not the player left the game. 0: didn't leave. 1: left safely. 2+: Abandoned","type":"integer"},"level":{"description":"Level at the end of the game","type":"integer"},"lh_t":{"description":"Array describing last hits at each minute in the game","type":"array","items":{"type":"integer"}},"life_state":{"description":"life_state","type":"object"},"max_hero_hit":{"description":"Object with information on the highest damage instance the player inflicted","type":"object"},"multi_kills":{"description":"Object with information on the number of the number of multikills the player had","type":"object"},"obs":{"description":"Object with information on where the player placed observer wards. The location takes the form (outer number, inner number) and are from ~64-192.","type":"object"},"obs_left_log":{"description":"obs_left_log","type":"array","items":{"type":"object"}},"obs_log":{"description":"Object containing information on when and where the player placed observer wards","type":"array","items":{"type":"object"}},"obs_placed":{"description":"Total number of observer wards placed","type":"integer"},"party_id":{"description":"party_id","type":"integer"},"permanent_buffs":{"description":"Array describing permanent buffs the player had at the end of the game. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/permanent_buffs.json","type":"array","items":{"type":"object"}},"pings":{"description":"Total number of pings","type":"integer"},"purchase":{"description":"Object containing information on the items the player purchased","type":"object"},"purchase_log":{"description":"Object containing information on when items were purchased","type":"array","items":{"type":"object","properties":{"time":{"description":"Time in seconds the item was bought","type":"integer"},"key":{"description":"String item ID","type":"string"},"charges":{"description":"Integer amount of charges","type":"integer"}}}},"rune_pickups":{"description":"Number of runes picked up","type":"integer"},"runes":{"description":"Object with information about which runes the player picked up","type":"object","additionalProperties":{"type":"integer"}},"runes_log":{"description":"Array with information on when runes were picked up","type":"array","items":{"type":"object","properties":{"time":{"description":"Time in seconds rune picked up","type":"integer"},"key":{"description":"key","type":"integer"}}}},"sen":{"description":"Object with information on where sentries were placed. The location takes the form (outer number, inner number) and are from ~64-192.","type":"object"},"sen_left_log":{"description":"Array containing information on when and where the player placed sentries","type":"array","items":{"type":"object"}},"sen_log":{"description":"Array with information on when and where sentries were placed by the player","type":"array","items":{"type":"object"}},"sen_placed":{"description":"How many sentries were placed by the player","type":"integer"},"stuns":{"description":"Total stun duration of all stuns by the player","type":"number"},"times":{"description":"Time in seconds corresponding to the time of entries of other arrays in the match.","type":"array","items":{"type":"integer"}},"tower_damage":{"description":"Total tower damage done by the player","type":"integer"},"xp_per_min":{"description":"Experience Per Minute obtained by the player","type":"integer"},"xp_reasons":{"description":"Object containing information on the sources of this player's experience","type":"object"},"xp_t":{"description":"Experience at each minute of the game","type":"array","items":{"type":"integer"}},"personaname":{"description":"personaname","type":"string","nullable":true},"name":{"description":"name","type":"string","nullable":true},"last_login":{"description":"Time of player's last login","type":"string","format":"date-time","nullable":true},"radiant_win":{"description":"Boolean indicating whether Radiant won the match","type":"boolean"},"start_time":{"description":"Start time of the match in seconds since 1970","type":"integer"},"duration":{"description":"Duration of the game in seconds","type":"integer"},"cluster":{"description":"cluster","type":"integer"},"lobby_type":{"description":"Integer corresponding to lobby type of match. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/lobby_type.json","type":"integer"},"game_mode":{"description":"Integer corresponding to game mode played. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/game_mode.json","type":"integer"},"patch":{"description":"Integer representing the patch the game was played on","type":"integer"},"region":{"description":"Integer corresponding to the region the game was played on","type":"integer"},"isRadiant":{"description":"Boolean for whether or not the player is on Radiant","type":"boolean"},"win":{"description":"Binary integer representing whether or not the player won","type":"integer"},"lose":{"description":"Binary integer representing whether or not the player lost","type":"integer"},"total_gold":{"description":"Total gold at the end of the game","type":"integer"},"total_xp":{"description":"Total experience at the end of the game","type":"integer"},"kills_per_min":{"description":"Number of kills per minute","type":"number"},"kda":{"description":"kda","type":"number"},"abandons":{"description":"abandons","type":"integer"},"neutral_kills":{"description":"Total number of neutral creeps killed","type":"integer"},"tower_kills":{"description":"Total number of tower kills the player had","type":"integer"},"courier_kills":{"description":"Total number of courier kills the player had","type":"integer"},"lane_kills":{"description":"Total number of lane creeps killed by the player","type":"integer"},"hero_kills":{"description":"Total number of heroes killed by the player","type":"integer"},"observer_kills":{"description":"Total number of observer wards killed by the player","type":"integer"},"sentry_kills":{"description":"Total number of sentry wards killed by the player","type":"integer"},"roshan_kills":{"description":"Total number of roshan kills (last hit on roshan) the player had","type":"integer"},"necronomicon_kills":{"description":"Total number of Necronomicon creeps killed by the player","type":"integer"},"ancient_kills":{"description":"Total number of Ancient creeps killed by the player","type":"integer"},"buyback_count":{"description":"Total number of buyback the player used","type":"integer"},"observer_uses":{"description":"Number of observer wards used","type":"integer"},"sentry_uses":{"description":"Number of sentry wards used","type":"integer"},"lane_efficiency":{"description":"lane_efficiency","type":"number"},"lane_efficiency_pct":{"description":"lane_efficiency_pct","type":"number"},"lane":{"description":"Integer referring to which lane the hero laned in","type":"integer","nullable":true},"lane_role":{"description":"lane_role","type":"integer","nullable":true},"is_roaming":{"description":"Boolean referring to whether or not the player roamed","type":"boolean","nullable":true},"purchase_time":{"description":"Object with information on when the player last purchased an item","type":"object"},"first_purchase_time":{"description":"Object with information on when the player first puchased an item","type":"object"},"item_win":{"description":"Object with information on whether or not the item won","type":"object"},"item_usage":{"description":"Object containing binary integers the tell whether the item was purchased by the player (note: this is always 1)","type":"object"},"purchase_tpscroll":{"description":"Total number of TP scrolls purchased by the player","type":"integer"},"actions_per_min":{"description":"Actions per minute","type":"integer"},"life_state_dead":{"description":"life_state_dead","type":"integer"},"rank_tier":{"description":"The rank tier of the player. Tens place indicates rank, ones place indicates stars.","type":"integer"},"cosmetics":{"description":"cosmetics","type":"array","items":{"type":"object","properties":{"item_id":{"type":"integer"},"name":{"type":"string"},"prefab":{"type":"string"},"creation_date":{"type":"string","format":"date-time","nullable":true},"image_inventory":{"type":"string","nullable":true},"image_path":{"type":"string","nullable":true},"item_description":{"type":"string","nullable":true},"item_name":{"type":"string"},"item_rarity":{"type":"string","nullable":true},"item_type_name":{"type":"string","nullable":true},"used_by_heroes":{"type":"string","nullable":true}}}},"benchmarks":{"description":"Object containing information on certain benchmarks like GPM, XPM, KDA, tower damage, etc","type":"object"}}}},"patch":{"description":"Information on the patch version the game is played on","type":"integer"},"region":{"description":"Integer corresponding to the region the game was played on","type":"integer"},"all_word_counts":{"description":"Word counts of the all chat messages in the player's games","type":"object"},"my_word_counts":{"description":"Word counts of the player's all chat messages","type":"object"},"throw":{"description":"Maximum gold advantage of the player's team if they lost the match","type":"integer"},"comeback":{"description":"Maximum gold disadvantage of the player's team if they won the match","type":"integer"},"loss":{"description":"Maximum gold disadvantage of the player's team if they lost the match","type":"integer"},"win":{"description":"Maximum gold advantage of the player's team if they won the match","type":"integer"},"replay_url":{"description":"replay_url","type":"string"}}},"PlayersByRankResponse":{"title":"PlayersByRankResponse","type":"array","items":{"type":"object","properties":{"account_id":{"description":"account_id","type":"number"},"rank_tier":{"description":"Integer indicating the rank/medal of the player","type":"number"},"fh_unavailable":{"description":"Indicates if we were unable to fetch full history for this player due to privacy settings","type":"boolean","nullable":true}}}},"PlayersResponse":{"title":"PlayerResponse","type":"object","properties":{"solo_competitive_rank":{"description":"solo_competitive_rank","type":"integer","nullable":true},"competitive_rank":{"description":"competitive_rank","type":"integer","nullable":true},"rank_tier":{"description":"rank_tier","type":"number","nullable":true},"leaderboard_rank":{"description":"leaderboard_rank","type":"number","nullable":true},"mmr_estimate":{"description":"mmr_estimate","type":"object","properties":{"estimate":{"description":"estimate","type":"number","nullable":true}}},"profile":{"description":"profile","type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"personaname":{"description":"personaname","type":"string","nullable":true},"name":{"description":"name","type":"string","nullable":true},"plus":{"description":"Boolean indicating status of current Dota Plus subscription","type":"boolean"},"cheese":{"description":"cheese","type":"integer","nullable":true},"steamid":{"description":"steamid","type":"string","nullable":true},"avatar":{"description":"avatar","type":"string","nullable":true},"avatarmedium":{"description":"avatarmedium","type":"string","nullable":true},"avatarfull":{"description":"avatarfull","type":"string","nullable":true},"profileurl":{"description":"profileurl","type":"string","nullable":true},"last_login":{"description":"last_login","type":"string","nullable":true},"loccountrycode":{"description":"loccountrycode","type":"string","nullable":true},"is_contributor":{"description":"Boolean indicating if the user contributed to the development of OpenDota","type":"boolean","default":false},"is_subscriber":{"description":"Boolean indicating if the user subscribed to OpenDota","type":"boolean","default":false}}}}},"PlayerWinLossResponse":{"title":"PlayerWinLossResponse","type":"object","properties":{"win":{"description":"Number of wins","type":"integer"},"lose":{"description":"Number of loses","type":"integer"}}},"PlayerRecentMatchesResponse":{"title":"PlayerRecentMatchesResponse","description":"match","type":"object","properties":{"match_id":{"description":"Match ID","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"},"radiant_win":{"description":"Boolean indicating whether Radiant won the match","type":"boolean"},"duration":{"description":"Duration of the game in seconds","type":"integer"},"game_mode":{"description":"Integer corresponding to game mode played. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/game_mode.json","type":"integer"},"lobby_type":{"description":"Integer corresponding to lobby type of match. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/lobby_type.json","type":"integer"},"hero_id":{"description":"The ID value of the hero played","type":"integer"},"start_time":{"description":"Start time of the match in seconds elapsed since 1970","type":"integer"},"version":{"description":"version","type":"integer","nullable":true},"kills":{"description":"Total kills the player had at the end of the match","type":"integer"},"deaths":{"description":"Total deaths the player had at the end of the match","type":"integer"},"assists":{"description":"Total assists the player had at the end of the match","type":"integer"},"skill":{"description":"Skill bracket assigned by Valve (Normal, High, Very High). If the skill is unknown, will return null.","type":"integer","nullable":true},"average_rank":{"description":"Average rank of players with public match data","type":"integer","nullable":true},"xp_per_min":{"description":"Experience Per Minute obtained by the player","type":"integer"},"gold_per_min":{"description":"Average gold per minute of the player","type":"integer"},"hero_damage":{"description":"Total hero damage to enemy heroes","type":"integer"},"hero_healing":{"description":"Total healing of ally heroes","type":"integer"},"last_hits":{"description":"Total last hits the player had at the end of the match","type":"integer"},"lane":{"description":"Integer corresponding to which lane the player laned in for the match","type":"integer","nullable":true},"lane_role":{"description":"lane_role","type":"integer","nullable":true},"is_roaming":{"description":"Boolean describing whether or not the player roamed","type":"boolean","nullable":true},"cluster":{"description":"cluster","type":"integer"},"leaver_status":{"description":"Integer describing whether or not the player left the game. 0: didn't leave. 1: left safely. 2+: Abandoned","type":"integer"},"party_size":{"description":"Size of the players party. If not in a party, will return 1.","type":"integer","nullable":true}}},"PlayerMatchesResponse":{"title":"PlayerMatchesResponse","description":"Object containing information on the match","type":"object","properties":{"match_id":{"description":"Match ID","type":"integer"},"player_slot":{"description":"Which slot the player is in. 0-127 are Radiant, 128-255 are Dire","type":"integer"},"radiant_win":{"description":"Boolean indicating whether Radiant won the match","type":"boolean"},"duration":{"description":"Duration of the game in seconds","type":"integer"},"game_mode":{"description":"Integer corresponding to game mode played. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/game_mode.json","type":"integer"},"lobby_type":{"description":"Integer corresponding to lobby type of match. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/lobby_type.json","type":"integer"},"hero_id":{"description":"The ID value of the hero played","type":"integer"},"start_time":{"description":"Time the game started in seconds since 1970","type":"integer"},"version":{"description":"version","type":"integer","nullable":true},"kills":{"description":"Total kills the player had at the end of the game","type":"integer"},"deaths":{"description":"Total deaths the player had at the end of the game","type":"integer"},"assists":{"description":"Total assists the player had at the end of the game","type":"integer"},"skill":{"description":"Skill bracket assigned by Valve (Normal, High, Very High)","type":"integer","nullable":true},"average_rank":{"description":"Average rank of players with public match data","type":"integer","nullable":true},"leaver_status":{"description":"Integer describing whether or not the player left the game. 0: didn't leave. 1: left safely. 2+: Abandoned","type":"integer"},"party_size":{"description":"Size of the player's party","type":"integer","nullable":true}}},"PlayerHeroesResponse":{"title":"PlayerHeroesResponse","description":"hero","type":"object","properties":{"hero_id":{"description":"The ID value of the hero played","type":"string"},"last_played":{"description":"last_played","type":"integer"},"games":{"description":"games","type":"integer"},"win":{"description":"win","type":"integer"},"with_games":{"description":"with_games","type":"integer"},"with_win":{"description":"with_win","type":"integer"},"against_games":{"description":"against_games","type":"integer"},"against_win":{"description":"against_win","type":"integer"}}},"PlayerPeersResponse":{"title":"PlayerPeersResponse","type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"last_played":{"description":"last_played","type":"integer"},"win":{"description":"win","type":"integer"},"games":{"description":"games","type":"integer"},"with_win":{"description":"with_win","type":"integer"},"with_games":{"description":"with_games","type":"integer"},"against_win":{"description":"against_win","type":"integer"},"against_games":{"description":"against_games","type":"integer"},"with_gpm_sum":{"description":"with_gpm_sum","type":"integer"},"with_xpm_sum":{"description":"with_xpm_sum","type":"integer"},"personaname":{"description":"personaname","type":"string","nullable":true},"name":{"description":"name","type":"string","nullable":true},"is_contributor":{"description":"is_contributor","type":"boolean"},"is_subscriber":{"description":"is_subscriber","type":"boolean"},"last_login":{"description":"last_login","type":"string","nullable":true},"avatar":{"description":"avatar","type":"string","nullable":true},"avatarfull":{"description":"avatarfull","type":"string","nullable":true}}},"PlayerProsResponse":{"title":"PlayerProsResponse","type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"name":{"description":"name","type":"string"},"country_code":{"description":"country_code","type":"string"},"fantasy_role":{"description":"fantasy_role","type":"integer"},"team_id":{"description":"team_id","type":"integer"},"team_name":{"description":"team_name","type":"string","nullable":true},"team_tag":{"description":"team_tag","type":"string","nullable":true},"is_locked":{"description":"is_locked","type":"boolean"},"is_pro":{"description":"is_pro","type":"boolean"},"locked_until":{"description":"locked_until","type":"integer","nullable":true},"steamid":{"description":"steamid","type":"string","nullable":true},"avatar":{"description":"avatar","type":"string","nullable":true},"avatarmedium":{"description":"avatarmedium","type":"string","nullable":true},"avatarfull":{"description":"avatarfull","type":"string","nullable":true},"profileurl":{"description":"profileurl","type":"string","nullable":true},"last_login":{"description":"last_login","type":"string","format":"date-time","nullable":true},"full_history_time":{"description":"full_history_time","type":"string","format":"date-time","nullable":true},"cheese":{"description":"cheese","type":"integer","nullable":true},"fh_unavailable":{"description":"fh_unavailable","type":"boolean","nullable":true},"loccountrycode":{"description":"loccountrycode","type":"string","nullable":true},"last_played":{"description":"last_played","type":"integer","nullable":true},"win":{"description":"win","type":"integer"},"games":{"description":"games","type":"integer"},"with_win":{"description":"with_win","type":"integer"},"with_games":{"description":"with_games","type":"integer"},"against_win":{"description":"against_win","type":"integer"},"against_games":{"description":"against_games","type":"integer"},"with_gpm_sum":{"description":"with_gpm_sum","type":"integer","nullable":true},"with_xpm_sum":{"description":"with_xpm_sum","type":"integer","nullable":true}}},"PlayerTotalsResponse":{"title":"PlayerTotalsResponse","type":"object","properties":{"field":{"description":"field","type":"string"},"n":{"description":"number","type":"integer"},"sum":{"description":"sum","type":"number"}}},"PlayerCountsResponse":{"title":"PlayerCountsResponse","type":"object","properties":{"leaver_status":{"description":"Integer describing whether or not the player left the game. 0: didn't leave. 1: left safely. 2+: Abandoned","type":"object"},"game_mode":{"description":"Integer corresponding to game mode played. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/game_mode.json","type":"object"},"lobby_type":{"description":"Integer corresponding to lobby type of match. List of constants can be found here: https://github.com/odota/dotaconstants/blob/master/json/lobby_type.json","type":"object"},"lane_role":{"description":"lane_role","type":"object"},"region":{"description":"Integer corresponding to the region the game was played on","type":"object"},"patch":{"description":"patch","type":"object"}}},"PlayerWardMapResponse":{"title":"PlayerWardMapResponse","type":"object","properties":{"obs":{"description":"obs","type":"object"},"sen":{"description":"sen","type":"object"}}},"PlayerWordCloudResponse":{"title":"PlayerWordCloudResponse","type":"object","properties":{"my_word_counts":{"description":"my_word_counts","type":"object"},"all_word_counts":{"description":"all_word_counts","type":"object"}}},"PlayerRatingsResponse":{"title":"PlayerRatingsResponse","type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"match_id":{"description":"match_id","type":"integer"},"solo_competitive_rank":{"description":"solo_competitive_rank","type":"integer","nullable":true},"competitive_rank":{"description":"competitive_rank","type":"integer"},"time":{"description":"time","type":"integer"}}},"PlayerRankingsResponse":{"title":"PlayerRankingsResponse","type":"object","properties":{"hero_id":{"description":"The ID value of the hero played","type":"integer"},"score":{"description":"hero_score","type":"number"},"percent_rank":{"description":"percent_rank","type":"number"},"card":{"description":"numeric_rank","type":"integer"}}},"TeamObjectResponse":{"title":"TeamObjectResponse","type":"object","properties":{"team_id":{"description":"Team's identifier","type":"integer"},"rating":{"description":"The Elo rating of the team","type":"number"},"wins":{"description":"The number of games won by this team","type":"integer"},"losses":{"description":"The number of losses by this team","type":"integer"},"last_match_time":{"description":"The Unix timestamp of the last match played by this team","type":"integer"},"name":{"description":"Team name, eg. 'Newbee'","type":"string"},"tag":{"description":"The team tag/abbreviation","type":"string"}}},"MatchObjectResponse":{"title":"MatchObjectResponse","type":"object","properties":{"match_id":{"description":"Used to identify individual matches, e.g. 3703866531","type":"integer"},"duration":{"description":"Length of the match","type":"integer"},"start_time":{"description":"Unix timestamp of when the match began","type":"integer"},"radiant_team_id":{"description":"The Radiant's team_id","type":"integer"},"radiant_name":{"description":"The Radiant's team name","type":"string"},"dire_team_id":{"description":"The Dire's team_id","type":"integer"},"dire_name":{"description":"The Dire's team name","type":"string"},"leagueid":{"description":"Identifier for the league the match took place in","type":"integer"},"league_name":{"description":"Name of league the match took place in","type":"string"},"series_id":{"description":"Identifier for the series of the match","type":"integer"},"series_type":{"description":"Type of series the match was","type":"integer"},"radiant_score":{"description":"Number of kills the Radiant team had when the match ended","type":"integer"},"dire_score":{"description":"Number of kills the Dire team had when the match ended","type":"integer"},"radiant_win":{"description":"Whether or not the Radiant won the match","type":"boolean"},"radiant":{"description":"Whether the team/player/hero was on Radiant","type":"boolean"}}},"TeamMatchObjectResponse":{"title":"TeamMatchObjectResponse","type":"object","properties":{"match_id":{"description":"Used to identify individual matches, e.g. 3703866531","type":"integer"},"radiant":{"description":"Whether the team/player/hero was on Radiant","type":"boolean"},"radiant_win":{"description":"Whether or not the Radiant won the match","type":"boolean"},"radiant_score":{"description":"Number of kills the Radiant team had when the match ended","type":"integer"},"dire_score":{"description":"Number of kills the Dire team had when the match ended","type":"integer"},"duration":{"description":"Length of the match","type":"integer"},"start_time":{"description":"Unix timestamp of when the match began","type":"integer"},"leagueid":{"description":"Identifier for the league the match took place in","type":"integer"},"league_name":{"description":"Name of league the match took place in","type":"string"},"cluster":{"description":"cluster","type":"integer"},"opposing_team_id":{"description":"Opposing team identifier","type":"integer"},"opposing_team_name":{"description":"Opposing team name, e.g. 'Evil Geniuses'","type":"string","nullable":true},"opposing_team_logo":{"description":"Opposing team logo url","type":"string"}}},"HeroObjectResponse":{"title":"HeroObjectResponse","type":"object","properties":{"id":{"description":"Numeric identifier for the hero object","type":"integer"},"name":{"description":"Dota hero command name, e.g. 'npc_dota_hero_antimage'","type":"string"},"localized_name":{"description":"Hero name, e.g. 'Anti-Mage'","type":"string"},"primary_attr":{"description":"Hero primary shorthand attribute name, e.g. 'agi'","type":"string"},"attack_type":{"description":"Hero attack type, either 'Melee' or 'Ranged'","type":"string"},"roles":{"type":"array","items":{"description":"A hero's role in the game","type":"string"}}}},"PlayerObjectResponse":{"title":"PlayerObjectResponse","type":"object","properties":{"account_id":{"description":"Player's account identifier","type":"integer"},"steamid":{"description":"Player's steam identifier","type":"string"},"avatar":{"description":"Steam picture URL (small picture)","type":"string"},"avatarmedium":{"description":"Steam picture URL (medium picture)","type":"string"},"avatarfull":{"description":"Steam picture URL (full picture)","type":"string"},"profileurl":{"description":"Steam profile URL","type":"string"},"personaname":{"description":"Player's Steam name","type":"string"},"last_login":{"description":"Date and time of last login to OpenDota","type":"string","format":"date-time"},"full_history_time":{"description":"Date and time of last request to refresh player's match history","type":"string","format":"date-time"},"cheese":{"description":"Amount of dollars the player has donated to OpenDota","type":"integer"},"fh_unavailable":{"description":"Whether the refresh of player' match history failed","type":"boolean"},"loccountrycode":{"description":"Player's country identifier, e.g. US","type":"string"},"name":{"description":"Verified player name, e.g. 'Miracle-'","type":"string"},"country_code":{"description":"Player's country code","type":"string"},"fantasy_role":{"description":"Player's ingame role (core: 1 or support: 2)","type":"integer"},"team_id":{"description":"Player's team identifier","type":"integer"},"team_name":{"description":"Player's team name, e.g. 'Evil Geniuses'","type":"string"},"team_tag":{"description":"Player's team shorthand tag, e.g. 'EG'","type":"string"},"is_locked":{"description":"Whether the roster lock is active","type":"boolean"},"is_pro":{"description":"Whether the player is professional or not","type":"boolean"},"locked_until":{"description":"When the roster lock will end","type":"integer"}}},"LeagueObjectResponse":{"title":"LeagueObjectResponse","type":"object","properties":{"leagueid":{"description":"leagueid","type":"integer"},"ticket":{"description":"ticket","type":"string"},"banner":{"description":"banner","type":"string"},"tier":{"description":"tier","type":"string"},"name":{"description":"name","type":"string"}}},"PublicMatchesResponse":{"title":"PublicMatchesResponse","type":"object","properties":{"match_id":{"description":"match_id","type":"integer"},"match_seq_num":{"description":"match_seq_num","type":"integer"},"radiant_win":{"description":"Boolean indicating whether Radiant won the match","type":"boolean"},"start_time":{"description":"start_time","type":"integer"},"duration":{"description":"Duration of the game in seconds","type":"integer"},"radiant_team":{"description":"radiant_team","type":"string"},"dire_team":{"description":"dire_team","type":"string"}}},"ParsedMatchesResponse":{"title":"ParsedMatchesResponse","type":"object","properties":{"match_id":{"description":"match_id","type":"integer"}}},"MetadataResponse":{"title":"MetadataResponse","type":"object","properties":{"banner":{"description":"banner","type":"object","nullable":true}}},"DistributionsResponse":{"title":"DistributionsResponse","type":"object","properties":{"ranks":{"description":"ranks","type":"object","properties":{"commmand":{"description":"command","type":"string"},"rowCount":{"description":"rowCount","type":"integer"},"rows":{"description":"rows","type":"array","items":{"type":"object","properties":{"bin":{"description":"bin","type":"integer"},"bin_name":{"description":"bin_name","type":"integer"},"count":{"description":"count","type":"integer"},"cumulative_sum":{"description":"cumulative_sum","type":"integer"}}}},"fields":{"description":"fields","type":"array","items":{"type":"object","properties":{"name":{"description":"name","type":"string"},"tableID":{"description":"tableID","type":"integer"},"columnID":{"description":"columnID","type":"integer"},"dataTypeID":{"description":"dataTypeID","type":"integer"},"dataTypeSize":{"description":"dataTypeSize","type":"integer"},"dataTypeModifier":{"description":"dataTypeModifier","type":"integer"},"format":{"description":"format","type":"string"}}}},"rowAsArray":{"description":"rowAsArray","type":"boolean"},"sum":{"description":"sum","type":"object","properties":{"count":{"description":"count","type":"integer"}}}}},"mmr":{"description":"mmr","type":"object","properties":{"commmand":{"description":"command","type":"string"},"rowCount":{"description":"rowCount","type":"integer"},"rows":{"description":"rows","type":"array","items":{"type":"object","properties":{"bin":{"description":"bin","type":"integer"},"bin_name":{"description":"bin_name","type":"integer"},"count":{"description":"count","type":"integer"},"cumulative_sum":{"description":"cumulative_sum","type":"integer"}}}},"fields":{"description":"fields","type":"array","items":{"type":"object","properties":{"name":{"description":"name","type":"string"},"tableID":{"description":"tableID","type":"integer"},"columnID":{"description":"columnID","type":"integer"},"dataTypeID":{"description":"dataTypeID","type":"integer"},"dataTypeSize":{"description":"dataTypeSize","type":"integer"},"dataTypeModifier":{"description":"dataTypeModifier","type":"integer"},"format":{"description":"format","type":"string"}}}},"rowAsArray":{"description":"rowAsArray","type":"boolean"},"sum":{"description":"sum","type":"object","properties":{"count":{"description":"count","type":"integer"}}}}},"country_mmr":{"description":"country_mmr","type":"object","properties":{"commmand":{"description":"command","type":"string"},"rowCount":{"description":"rowCount","type":"integer"},"rows":{"description":"rows","type":"array","items":{"type":"object","properties":{"loccountrycode":{"description":"loccountrycode","type":"string","nullable":true},"count":{"description":"count","type":"integer"},"avg":{"description":"avg","type":"string"},"common":{"description":"common","type":"string"}}}},"fields":{"description":"fields","type":"array","items":{"type":"object","properties":{"name":{"description":"name","type":"string"},"tableID":{"description":"tableID","type":"integer"},"columnID":{"description":"columnID","type":"integer"},"dataTypeID":{"description":"dataTypeID","type":"integer"},"dataTypeSize":{"description":"dataTypeSize","type":"integer"},"dataTypeModifier":{"description":"dataTypeModifier","type":"integer"},"format":{"description":"format","type":"string"}}}},"rowAsArray":{"description":"rowAsArray","type":"boolean"}}}}},"SearchResponse":{"title":"SearchResponse","type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"avatarfull":{"description":"avatarfull","type":"string","nullable":true},"personaname":{"description":"personaname","type":"string","nullable":true},"last_match_time":{"description":"last_match_time. May not be present or null.","type":"string"},"similarity":{"description":"similarity","type":"number"}}},"RankingsResponse":{"title":"RankingsResponse","type":"object","properties":{"hero_id":{"description":"The ID value of the hero played","type":"integer"},"rankings":{"description":"rankings","type":"array","items":{"type":"object","properties":{"account_id":{"description":"account_id","type":"integer"},"score":{"description":"score","type":"number"},"steamid":{"description":"steamid","type":"string","nullable":true},"avatar":{"description":"avatar","type":"string","nullable":true},"avatarmedium":{"description":"avatarmedium","type":"string","nullable":true},"avatarfull":{"description":"avatarfull","type":"string","nullable":true},"profileurl":{"description":"profileurl","type":"string","nullable":true},"personaname":{"description":"personaname","type":"string","nullable":true},"last_login":{"description":"last_login","type":"string","format":"date-time","nullable":true},"full_history_time":{"description":"full_history_time","type":"string","format":"date-time"},"cheese":{"description":"cheese","type":"integer","nullable":true},"fh_unavailable":{"description":"fh_unavailable","type":"boolean","nullable":true},"loccountrycode":{"description":"loccountrycode","type":"string","nullable":true},"rank_tier":{"description":"rank_tier","type":"integer","nullable":true}}}}}},"BenchmarksResponse":{"title":"BenchmarksResponse","type":"object","properties":{"hero_id":{"description":"The ID value of the hero played","type":"integer"},"result":{"description":"result","type":"object","properties":{"gold_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"xp_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"kills_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"last_hits_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"hero_damage_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"hero_healing_per_min":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"number"}}}},"tower_damage":{"type":"array","items":{"type":"object","properties":{"percentile":{"description":"percentile","type":"number"},"value":{"description":"value","type":"integer"}}}}}}}},"HeroStatsResponse":{"title":"HeroStatsResponse","type":"object","properties":{"id":{"description":"id","type":"integer"},"name":{"description":"name","type":"string"},"localized_name":{"description":"localized_name","type":"string"},"img":{"description":"img","type":"string"},"icon":{"description":"icon","type":"string"},"pro_win":{"description":"pro_win","type":"integer"},"pro_pick":{"description":"pro_pick","type":"integer"},"hero_id":{"description":"The ID value of the hero played","type":"integer"},"pro_ban":{"description":"pro_ban","type":"integer"},"1_pick":{"description":"Herald picks","type":"integer"},"1_win":{"description":"Herald wins","type":"integer"},"2_pick":{"description":"Guardian picks","type":"integer"},"2_win":{"description":"Guardian wins","type":"integer"},"3_pick":{"description":"Crusader picks","type":"integer"},"3_win":{"description":"Crusader wins","type":"integer"},"4_pick":{"description":"Archon picks","type":"integer"},"4_win":{"description":"Archon wins","type":"integer"},"5_pick":{"description":"Legend picks","type":"integer"},"5_win":{"description":"Legend wins","type":"integer"},"6_pick":{"description":"Ancient picks","type":"integer"},"6_win":{"description":"Ancient wins","type":"integer"},"7_pick":{"description":"Divine picks","type":"integer"},"7_win":{"description":"Divine wins","type":"integer"},"8_pick":{"description":"Immortal picks","type":"integer"},"8_win":{"description":"Immortal wins","type":"integer"},"turbo_pick":{"description":"Picks in Turbo mode this month","type":"integer"},"turbo_win":{"description":"Wins in Turbo mode this month","type":"integer"}}},"HeroMatchupsResponse":{"title":"HeroMatchupsResponse","type":"object","properties":{"hero_id":{"description":"Numeric identifier for the hero object","type":"integer"},"games_played":{"description":"Number of games played","type":"integer"},"wins":{"description":"Number of games won","type":"integer"}}},"HeroDurationsResponse":{"title":"HeroDurationsResponse","type":"object","properties":{"duration_bin":{"description":"Lower bound of number of seconds the match lasted","type":"string"},"games_played":{"description":"Number of games played","type":"integer"},"wins":{"description":"Number of wins","type":"integer"}}},"HeroItemPopularityResponse":{"title":"HeroItemPopularityResponse","type":"object","properties":{"start_game_items":{"description":"Items bought before game started","type":"object","properties":{"item":{"description":"Number of item bought","type":"integer"}}},"early_game_items":{"description":"Items bought in the first 10 min of the game, with cost at least 700","type":"object","properties":{"item":{"description":"Number of item bought","type":"integer"}}},"mid_game_items":{"description":"Items bought between 10 and 25 min of the game, with cost at least 2000","type":"object","properties":{"item":{"description":"Number of item bought","type":"integer"}}},"late_game_items":{"description":"Items bought at least 25 min after game started, with cost at least 4000","type":"object","properties":{"item":{"description":"Number of item bought","type":"integer"}}}}},"TeamPlayersResponse":{"title":"TeamPlayersResponse","type":"object","properties":{"account_id":{"description":"The player account ID","type":"string"},"name":{"description":"The player name","type":"string"},"games_played":{"description":"Number of games played","type":"integer"},"wins":{"description":"Number of wins","type":"integer"},"is_current_team_member":{"description":"If this player is on the current roster","type":"boolean"}}},"TeamHeroesResponse":{"title":"TeamHeroesResponse","type":"object","properties":{"hero_id":{"description":"The hero ID","type":"integer"},"name":{"description":"The hero name","type":"string"},"games_played":{"description":"Number of games played","type":"integer"},"wins":{"description":"Number of wins","type":"integer"}}},"ReplaysResponse":{"title":"ReplaysResponse","type":"object","properties":{"match_id":{"description":"match_id","type":"integer"},"cluster":{"description":"cluster","type":"integer"},"replay_salt":{"description":"replay_salt","type":"integer"}}},"RecordsResponse":{"title":"RecordsResponse","type":"object","properties":{"match_id":{"description":"match_id","type":"string"},"start_time":{"description":"start_time","type":"string"},"hero_id":{"description":"The ID value of the hero played","type":"string"},"score":{"description":"score","type":"string"}}},"ScenarioItemTimingsResponse":{"title":"ScenarioItemTimingsResponse","type":"object","properties":{"hero_id":{"description":"Hero ID","type":"integer"},"item":{"description":"Purchased item","type":"string"},"time":{"description":"Ingame time in seconds before the item was purchased","type":"integer"},"games":{"description":"The number of games where the hero bought this item before this time","type":"string"},"wins":{"description":"The number of games won where the hero bought this item before this time","type":"string"}}},"ScenarioLaneRolesResponse":{"title":"ScenarioLaneRolesResponse","type":"object","properties":{"hero_id":{"description":"Hero ID","type":"integer"},"lane_role":{"description":"The hero's lane role","type":"integer"},"time":{"description":"Maximum game length in seconds","type":"integer"},"games":{"description":"The number of games where the hero played in this lane role","type":"string"},"wins":{"description":"The number of games won where the hero played in this lane role","type":"string"}}},"ScenarioMiscResponse":{"title":"ScenarioMiscResponse","type":"object","properties":{"scenario":{"description":"The scenario's name or description","type":"string"},"is_radiant":{"description":"Boolean indicating whether Radiant executed this scenario","type":"boolean"},"region":{"description":"Region the game was played in","type":"integer"},"games":{"description":"The number of games where this scenario occurred","type":"string"},"wins":{"description":"The number of games won where this scenario occured","type":"string"}}},"SchemaResponse":{"title":"SchemaResponse","type":"object","properties":{"table_name":{"description":"table_name","type":"string"},"column_name":{"description":"column_name","type":"string"},"data_type":{"description":"data_type","type":"string"}}}},"parameters":{"matchIdParam":{"name":"match_id","in":"path","required":true,"schema":{"type":"integer"}},"accountIdParam":{"name":"account_id","in":"path","description":"Steam32 account ID","required":true,"schema":{"type":"integer"}},"teamIdPathParam":{"name":"team_id","in":"path","description":"Team ID","required":true,"schema":{"type":"integer"}},"leagueIdPathParam":{"name":"league_id","in":"path","description":"League ID","required":true,"schema":{"type":"integer"}},"heroIdPathParam":{"name":"hero_id","in":"path","description":"Hero ID","required":true,"schema":{"type":"integer"}},"fieldParam":{"name":"field","in":"path","description":"Field to aggregate on","required":true,"schema":{"type":"string"}},"limitParam":{"name":"limit","in":"query","description":"Number of matches to limit to","required":false,"schema":{"type":"integer"}},"offsetParam":{"name":"offset","in":"query","description":"Number of matches to offset start by","required":false,"schema":{"type":"integer"}},"projectParam":{"name":"project","in":"query","description":"Fields to project (array)","required":false,"schema":{"type":"string"}},"winParam":{"name":"win","in":"query","description":"Whether the player won","required":false,"schema":{"type":"integer"}},"patchParam":{"name":"patch","in":"query","description":"Patch ID","required":false,"schema":{"type":"integer"}},"gameModeParam":{"name":"game_mode","in":"query","description":"Game Mode ID","required":false,"schema":{"type":"integer"}},"lobbyTypeParam":{"name":"lobby_type","in":"query","description":"Lobby type ID","required":false,"schema":{"type":"integer"}},"regionParam":{"name":"region","in":"query","description":"Region ID","required":false,"schema":{"type":"integer"}},"dateParam":{"name":"date","in":"query","description":"Days previous","required":false,"schema":{"type":"integer"}},"laneRoleParam":{"name":"lane_role","in":"query","description":"Lane Role ID","required":false,"schema":{"type":"integer"}},"heroIdParam":{"name":"hero_id","in":"query","description":"Hero ID","required":false,"schema":{"type":"integer"}},"isRadiantParam":{"name":"is_radiant","in":"query","description":"Whether the player was radiant","required":false,"schema":{"type":"integer"}},"withHeroIdParam":{"name":"with_hero_id","in":"query","description":"Hero IDs on the player's team (array)","required":false,"schema":{"type":"integer"}},"againstHeroIdParam":{"name":"against_hero_id","in":"query","description":"Hero IDs against the player's team (array)","required":false,"schema":{"type":"integer"}},"withAccountIdParam":{"name":"with_account_id","in":"query","description":"Account IDs on the player's team (array)","required":false,"schema":{"type":"integer"}},"againstAccountIdParam":{"name":"against_account_id","in":"query","description":"Account IDs against the player's team (array)","required":false,"schema":{"type":"integer"}},"includedAccountIdParam":{"name":"included_account_id","in":"query","description":"Account IDs in the match (array)","required":false,"schema":{"type":"integer"}},"excludedAccountIdParam":{"name":"excluded_account_id","in":"query","description":"Account IDs not in the match (array)","required":false,"schema":{"type":"integer"}},"significantParam":{"name":"significant","in":"query","description":"Whether the match was significant for aggregation purposes. Defaults to 1 (true), set this to 0 to return data for non-standard modes/matches.","required":false,"schema":{"type":"integer"}},"sortParam":{"name":"sort","in":"query","description":"The field to return matches sorted by in descending order","required":false,"schema":{"type":"string"}},"havingParam":{"name":"having","in":"query","description":"The minimum number of games played, for filtering hero stats","required":false,"schema":{"type":"integer"}},"minMmrParam":{"name":"min_mmr","in":"query","description":"Minimum average MMR","required":false,"schema":{"type":"integer"}},"maxMmrParam":{"name":"max_mmr","in":"query","description":"Maximum average MMR","required":false,"schema":{"type":"integer"}},"minTimeParam":{"name":"min_time","in":"query","description":"Minimum start time (Unix time)","required":false,"schema":{"type":"integer"}},"maxTimeParam":{"name":"max_time","in":"query","description":"Maximum start time (Unix time)","required":false,"schema":{"type":"integer"}},"mmrAscendingParam":{"name":"mmr_ascending","in":"query","description":"Order by MMR ascending","required":false,"schema":{"type":"integer"}},"mmrDescendingParam":{"name":"mmr_descending","in":"query","description":"Order by MMR descending","required":false,"schema":{"type":"integer"}},"lessThanMatchIdParam":{"name":"less_than_match_id","in":"query","description":"Get matches with a match ID lower than this value","required":false,"schema":{"type":"integer"}},"matchOverviewParam":{"name":"overview","in":"query","description":"Only fetch data required for match overview page","required":false,"schema":{"type":"integer"}},"scenarioParam":{"name":"scenario","in":"query","description":"pos_chat_1min,neg_chat_1min,courier_kill,first_blood","required":false,"schema":{"type":"string"}}}},"paths":{"/matches/{match_id}":{"get":{"summary":"GET /matches/{match_id}","description":"Match data","tags":["matches"],"parameters":[{"$ref":"#/components/parameters/matchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/MatchResponse"}}}}}}},"/playersByRank":{"get":{"summary":"GET /playersByRank","description":"Players ordered by rank/medal tier","tags":["playersByRank"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayersByRankResponse"}}}}}}},"/players/{account_id}":{"get":{"summary":"GET /players/{account_id}","description":"Player data","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayersResponse"}}}}}}},"/players/{account_id}/wl":{"get":{"summary":"GET /players/{account_id}/wl","description":"Win/Loss count","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayerWinLossResponse"}}}}}}},"/players/{account_id}/recentMatches":{"get":{"summary":"GET /players/{account_id}/recentMatches","description":"Recent matches played","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"type":"object","items":{"$ref":"#/components/schemas/PlayerRecentMatchesResponse"}}}}}}}}},"/players/{account_id}/matches":{"get":{"summary":"GET /players/{account_id}/matches","description":"Matches played","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/projectParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerMatchesResponse"}}}}}}}},"/players/{account_id}/heroes":{"get":{"summary":"GET /players/{account_id}/heroes","description":"Heroes played","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerHeroesResponse"}}}}}}}},"/players/{account_id}/peers":{"get":{"summary":"GET /players/{account_id}/peers","description":"Players played with","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerPeersResponse"}}}}}}}},"/players/{account_id}/pros":{"get":{"summary":"GET /players/{account_id}/pros","description":"Pro players played with","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerProsResponse"}}}}}}}},"/players/{account_id}/totals":{"get":{"summary":"GET /players/{account_id}/totals","description":"Totals in stats","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerTotalsResponse"}}}}}}}},"/players/{account_id}/counts":{"get":{"summary":"GET /players/{account_id}/counts","description":"Counts in categories","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayerCountsResponse"}}}}}}},"/players/{account_id}/histograms/{field}":{"get":{"summary":"GET /players/{account_id}/histograms","description":"Distribution of matches in a single stat","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/fieldParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"title":"PlayerHistogramsResponse","type":"object"}}}}}}}},"/players/{account_id}/wardmap":{"get":{"summary":"GET /players/{account_id}/wardmap","description":"Wards placed in matches played","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayerWardMapResponse"}}}}}}},"/players/{account_id}/wordcloud":{"get":{"summary":"GET /players/{account_id}/wordcloud","description":"Words said/read in matches played","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/winParam"},{"$ref":"#/components/parameters/patchParam"},{"$ref":"#/components/parameters/gameModeParam"},{"$ref":"#/components/parameters/lobbyTypeParam"},{"$ref":"#/components/parameters/regionParam"},{"$ref":"#/components/parameters/dateParam"},{"$ref":"#/components/parameters/laneRoleParam"},{"$ref":"#/components/parameters/heroIdParam"},{"$ref":"#/components/parameters/isRadiantParam"},{"$ref":"#/components/parameters/includedAccountIdParam"},{"$ref":"#/components/parameters/excludedAccountIdParam"},{"$ref":"#/components/parameters/withHeroIdParam"},{"$ref":"#/components/parameters/againstHeroIdParam"},{"$ref":"#/components/parameters/significantParam"},{"$ref":"#/components/parameters/havingParam"},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PlayerWordCloudResponse"}}}}}}},"/players/{account_id}/ratings":{"get":{"summary":"GET /players/{account_id}/ratings","description":"Player rating history","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerRatingsResponse"}}}}}}}},"/players/{account_id}/rankings":{"get":{"summary":"GET /players/{account_id}/rankings","description":"Player hero rankings","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerRankingsResponse"}}}}}}}},"/players/{account_id}/refresh":{"post":{"summary":"POST /players/{account_id}/refresh","description":"Refresh player match history","tags":["players"],"parameters":[{"$ref":"#/components/parameters/accountIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"PlayerRefreshResponse","type":"object"}}}}}}},"/proPlayers":{"get":{"summary":"GET /proPlayers","description":"Get list of pro players","tags":["pro players"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PlayerObjectResponse"}}}}}}}},"/proMatches":{"get":{"summary":"GET /proMatches","description":"Get list of pro matches","tags":["pro matches"],"parameters":[{"$ref":"#/components/parameters/lessThanMatchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchObjectResponse"}}}}}}}},"/publicMatches":{"get":{"summary":"GET /publicMatches","description":"Get list of randomly sampled public matches","tags":["public matches"],"parameters":[{"$ref":"#/components/parameters/mmrAscendingParam"},{"$ref":"#/components/parameters/mmrDescendingParam"},{"$ref":"#/components/parameters/lessThanMatchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicMatchesResponse"}}}}}}}},"/parsedMatches":{"get":{"summary":"GET /parsedMatches","description":"Get list of parsed match IDs","tags":["parsed matches"],"parameters":[{"$ref":"#/components/parameters/lessThanMatchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ParsedMatchesResponse"}}}}}}}},"/explorer":{"get":{"summary":"GET /explorer","description":"Submit arbitrary SQL queries to the database","tags":["explorer"],"parameters":[{"name":"sql","in":"query","description":"The PostgreSQL query as percent-encoded string.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"ExplorerResponse","type":"object"}}}}}}},"/metadata":{"get":{"summary":"GET /metadata","description":"Site metadata","tags":["metadata"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/MetadataResponse"}}}}}}},"/distributions":{"get":{"summary":"GET /distributions","description":"Distributions of MMR data by bracket and country","tags":["distributions"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/DistributionsResponse"}}}}}}},"/search":{"get":{"summary":"GET /search","description":"Search players by personaname.","tags":["search"],"parameters":[{"name":"q","in":"query","description":"Search string","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResponse"}}}}}}}},"/rankings":{"get":{"summary":"GET /rankings","description":"Top players by hero","tags":["rankings"],"parameters":[{"name":"hero_id","in":"query","description":"Hero ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RankingsResponse"}}}}}}},"/benchmarks":{"get":{"summary":"GET /benchmarks","description":"Benchmarks of average stat values for a hero","tags":["benchmarks"],"parameters":[{"name":"hero_id","in":"query","description":"Hero ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BenchmarksResponse"}}}}}}},"/status":{"get":{"summary":"GET /status","description":"Get current service statistics","tags":["status"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"StatusResponse","type":"object"}}}}}}},"/health":{"get":{"summary":"GET /health","description":"Get service health data","tags":["health"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"HealthResponse","type":"object"}}}}}}},"/request/{jobId}":{"get":{"summary":"GET /request/{jobId}","description":"Get parse request state","tags":["request"],"parameters":[{"name":"jobId","in":"path","description":"The job ID to query.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"RequestJobResponse","type":"object"}}}}}}},"/request/{match_id}":{"post":{"summary":"POST /request/{match_id}","description":"Submit a new parse request","tags":["request"],"parameters":[{"$ref":"#/components/parameters/matchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"RequestMatchResponse","type":"object"}}}}}}},"/findMatches":{"get":{"summary":"GET /","description":"Finds recent matches by heroes played","tags":["findMatches"],"parameters":[{"name":"teamA","in":"query","description":"Hero IDs on first team (array)","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"teamB","in":"query","description":"Hero IDs on second team (array)","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"title":"FindMatchesResponse","type":"array","items":{"type":"object"}}}}}}}},"/heroes":{"get":{"summary":"GET /heroes","description":"Get hero data","tags":["heroes"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeroObjectResponse"}}}}}}}},"/heroStats":{"get":{"summary":"GET /heroStats","description":"Get stats about hero performance in recent matches","tags":["hero stats"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeroStatsResponse"}}}}}}}},"/heroes/{hero_id}/matches":{"get":{"summary":"GET /heroes/{hero_id}/matches","description":"Get recent matches with a hero","tags":["heroes"],"parameters":[{"$ref":"#/components/parameters/heroIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchObjectResponse"}}}}}}}},"/heroes/{hero_id}/matchups":{"get":{"summary":"GET /heroes/{hero_id}/matchups","description":"Get results against other heroes for a hero","tags":["heroes"],"parameters":[{"$ref":"#/components/parameters/heroIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeroMatchupsResponse"}}}}}}}},"/heroes/{hero_id}/durations":{"get":{"summary":"GET /heroes/{hero_id}/durations","description":"Get hero performance over a range of match durations","tags":["heroes"],"parameters":[{"$ref":"#/components/parameters/heroIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HeroDurationsResponse"}}}}}}}},"/heroes/{hero_id}/players":{"get":{"summary":"GET /heroes/{hero_id}/players","description":"Get players who have played this hero","tags":["heroes"],"parameters":[{"$ref":"#/components/parameters/heroIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/PlayerObjectResponse"}}}}}}}}},"/heroes/{hero_id}/itemPopularity":{"get":{"summary":"GET /heroes/{hero_id}/itemPopularity","description":"Get item popularity of hero categoried by start, early, mid and late game, analyzed from professional games","tags":["heroes"],"parameters":[{"$ref":"#/components/parameters/heroIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/HeroItemPopularityResponse"}}}}}}},"/leagues":{"get":{"summary":"GET /leagues","description":"Get league data","tags":["leagues"],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeagueObjectResponse"}}}}}}}},"/leagues/{league_id}":{"get":{"summary":"GET /leagues/{league_id}","description":"Get data for a league","tags":["leagues"],"parameters":[{"$ref":"#/components/parameters/leagueIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeagueObjectResponse"}}}}}}}},"/leagues/{league_id}/matches":{"get":{"summary":"GET /leagues/{league_id}/matches","description":"Get matches for a team","tags":["leagues"],"parameters":[{"$ref":"#/components/parameters/leagueIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/MatchObjectResponse"}}}}}}},"/leagues/{league_id}/teams":{"get":{"summary":"GET /leagues/{league_id}/teams","description":"Get teams for a league","tags":["leagues"],"parameters":[{"$ref":"#/components/parameters/leagueIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/TeamObjectResponse"}}}}}}},"/teams":{"get":{"summary":"GET /teams","description":"Get team data","tags":["teams"],"parameters":[{"name":"page","in":"query","description":"Page number, zero indexed. Each page returns up to 1000 entries.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamObjectResponse"}}}}}}}},"/teams/{team_id}":{"get":{"summary":"GET /teams/{team_id}","description":"Get data for a team","tags":["teams"],"parameters":[{"$ref":"#/components/parameters/teamIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/TeamObjectResponse"}}}}}}},"/teams/{team_id}/matches":{"get":{"summary":"GET /teams/{team_id}/matches","description":"Get matches for a team","tags":["teams"],"parameters":[{"$ref":"#/components/parameters/teamIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/TeamMatchObjectResponse"}}}}}}},"/teams/{team_id}/players":{"get":{"summary":"GET /teams/{team_id}/players","description":"Get players who have played for a team","tags":["teams"],"parameters":[{"$ref":"#/components/parameters/teamIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/TeamPlayersResponse"}}}}}}},"/teams/{team_id}/heroes":{"get":{"summary":"GET /teams/{team_id}/heroes","description":"Get heroes for a team","tags":["teams"],"parameters":[{"$ref":"#/components/parameters/teamIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/TeamHeroesResponse"}}}}}}},"/replays":{"get":{"summary":"GET /replays","description":"Get data to construct a replay URL with","tags":["replays"],"parameters":[{"$ref":"#/components/parameters/matchIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReplaysResponse"}}}}}}}},"/records/{field}":{"get":{"summary":"GET /records/{field}","description":"Get top performances in a stat","tags":["records"],"parameters":[{"name":"field","in":"path","description":"Field name to query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordsResponse"}}}}}}}},"/live":{"get":{"summary":"GET /live","description":"Get top currently ongoing live games","tags":["live"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"title":"LiveResponse","type":"object","properties":{}}}}}}}}},"/scenarios/itemTimings":{"get":{"summary":"GET /scenarios/itemTimings","description":"Win rates for certain item timings on a hero for items that cost at least 1400 gold","tags":["scenarios"],"parameters":[{"name":"item","in":"query","description":"Filter by item name e.g. \"spirit_vessel\"","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/heroIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioItemTimingsResponse"}}}}}}}},"/scenarios/laneRoles":{"get":{"summary":"GET /scenarios/laneRoles","description":"Win rates for heroes in certain lane roles","tags":["scenarios"],"parameters":[{"name":"lane_role","in":"query","description":"Filter by lane role 1-4 (Safe, Mid, Off, Jungle)","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/heroIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioLaneRolesResponse"}}}}}}}},"/scenarios/misc":{"get":{"summary":"GET /scenarios/misc","description":"Miscellaneous team scenarios","tags":["scenarios"],"parameters":[{"$ref":"#/components/parameters/scenarioParam"}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioMiscResponse"}}}}}}}},"/schema":{"get":{"summary":"GET /schema","description":"Get database schema","tags":["schema"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchemaResponse"}}}}}}}},"/constants/{resource}":{"get":{"summary":"GET /constants","description":"Get static game data mirrored from the dotaconstants repository.","tags":["constants"],"parameters":[{"name":"resource","in":"path","description":"Resource name e.g. `heroes`. [List of resources](https://github.com/odota/dotaconstants/tree/master/build)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"nullable":true,"oneOf":[{"type":"object","additionalProperties":{"title":"ConstantResourceResponse"}},{"type":"array","items":{"oneOf":[{"type":"object","additionalProperties":{"title":"ConstantResourceResponse"}},{"type":"integer"}]}}]}}}}}}},"/constants":{"get":{"summary":"GET /constants","description":"Gets an array of available resources.","tags":["constants"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"title":"ConstantsResponse","type":"string"}}}}}}}}}}
\ No newline at end of file
diff --git a/samples/client/github/jetbrains/http/client/.openapi-generator-ignore b/samples/client/github/jetbrains/http/client/.openapi-generator-ignore
new file mode 100644
index 000000000000..7484ee590a38
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/samples/client/github/jetbrains/http/client/.openapi-generator/FILES b/samples/client/github/jetbrains/http/client/.openapi-generator/FILES
new file mode 100644
index 000000000000..75193ca13a5f
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/.openapi-generator/FILES
@@ -0,0 +1,36 @@
+Apis/ActionsApi.http
+Apis/ActivityApi.http
+Apis/AppsApi.http
+Apis/BillingApi.http
+Apis/ChecksApi.http
+Apis/ClassroomApi.http
+Apis/CodeScanningApi.http
+Apis/CodesOfConductApi.http
+Apis/CodespacesApi.http
+Apis/CopilotApi.http
+Apis/DependabotApi.http
+Apis/DependencyGraphApi.http
+Apis/EmojisApi.http
+Apis/GistsApi.http
+Apis/GitApi.http
+Apis/GitignoreApi.http
+Apis/InteractionsApi.http
+Apis/IssuesApi.http
+Apis/LicensesApi.http
+Apis/MarkdownApi.http
+Apis/MetaApi.http
+Apis/MigrationsApi.http
+Apis/OidcApi.http
+Apis/OrgsApi.http
+Apis/PackagesApi.http
+Apis/ProjectsApi.http
+Apis/PullsApi.http
+Apis/RateLimitApi.http
+Apis/ReactionsApi.http
+Apis/ReposApi.http
+Apis/SearchApi.http
+Apis/SecretScanningApi.http
+Apis/SecurityAdvisoriesApi.http
+Apis/TeamsApi.http
+Apis/UsersApi.http
+README.md
diff --git a/samples/client/github/jetbrains/http/client/.openapi-generator/VERSION b/samples/client/github/jetbrains/http/client/.openapi-generator/VERSION
new file mode 100644
index 000000000000..c9e125ba1880
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.4.0-SNAPSHOT
diff --git a/samples/client/github/jetbrains/http/client/Apis/ActionsApi.http b/samples/client/github/jetbrains/http/client/Apis/ActionsApi.http
new file mode 100644
index 000000000000..7b70d83b4890
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ActionsApi.http
@@ -0,0 +1,786 @@
+## ActionsApi
+
+### Add custom labels to a self-hosted runner for an organization
+## Add custom labels to a self-hosted runner for an organization
+POST https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "gpu", "accelerated" ]
+}
+
+
+### Add custom labels to a self-hosted runner for a repository
+## Add custom labels to a self-hosted runner for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "gpu", "accelerated" ]
+}
+
+
+### Add selected repository to an organization secret
+## Add selected repository to an organization secret
+PUT https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}/repositories/{{repository_id}}
+
+### Add selected repository to an organization variable
+## Add selected repository to an organization variable
+PUT https://api.github.com/orgs/{{org}}/actions/variables/{{name}}/repositories/{{repository_id}}
+
+### Approve a workflow run for a fork pull request
+## Approve a workflow run for a fork pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/approve
+Accept: application/json
+
+### Cancel a workflow run
+## Cancel a workflow run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/cancel
+Accept: application/json
+
+### Create an environment variable
+## Create an environment variable
+POST https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat"
+}
+
+
+### Create or update an environment secret
+## Create or update an environment secret
+PUT https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678"
+}
+
+
+### Create or update an organization secret
+## Create or update an organization secret
+PUT https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678",
+ "visibility" : "selected",
+ "selected_repository_ids" : [ 1296269, 1296280 ]
+}
+
+
+### Create or update a repository secret
+## Create or update a repository secret
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678"
+}
+
+
+### Create an organization variable
+## Create an organization variable
+POST https://api.github.com/orgs/{{org}}/actions/variables
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat",
+ "visibility" : "selected",
+ "selected_repository_ids" : [ 1296269, 1296280 ]
+}
+
+
+### Create a registration token for an organization
+## Create a registration token for an organization
+POST https://api.github.com/orgs/{{org}}/actions/runners/registration-token
+Accept: application/json
+
+### Create a registration token for a repository
+## Create a registration token for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/registration-token
+Accept: application/json
+
+### Create a remove token for an organization
+## Create a remove token for an organization
+POST https://api.github.com/orgs/{{org}}/actions/runners/remove-token
+Accept: application/json
+
+### Create a remove token for a repository
+## Create a remove token for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/remove-token
+Accept: application/json
+
+### Create a repository variable
+## Create a repository variable
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat"
+}
+
+
+### Create a workflow dispatch event
+## Create a workflow dispatch event
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/dispatches
+Content-Type: application/json
+
+{
+ "ref" : "topic-branch",
+ "inputs" : {
+ "name" : "Mona the Octocat",
+ "home" : "San Francisco, CA"
+ }
+}
+
+
+### Delete a GitHub Actions cache for a repository (using a cache ID)
+## Delete a GitHub Actions cache for a repository (using a cache ID)
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches/{{cache_id}}
+
+### Delete GitHub Actions caches for a repository (using a cache key)
+## Delete GitHub Actions caches for a repository (using a cache key)
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches
+Accept: application/json
+
+### Delete an artifact
+## Delete an artifact
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts/{{artifact_id}}
+
+### Delete an environment secret
+## Delete an environment secret
+DELETE https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets/{{secret_name}}
+
+### Delete an environment variable
+## Delete an environment variable
+DELETE https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables/{{name}}
+
+### Delete an organization secret
+## Delete an organization secret
+DELETE https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}
+
+### Delete an organization variable
+## Delete an organization variable
+DELETE https://api.github.com/orgs/{{org}}/actions/variables/{{name}}
+
+### Delete a repository secret
+## Delete a repository secret
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets/{{secret_name}}
+
+### Delete a repository variable
+## Delete a repository variable
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables/{{name}}
+
+### Delete a self-hosted runner from an organization
+## Delete a self-hosted runner from an organization
+DELETE https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}
+
+### Delete a self-hosted runner from a repository
+## Delete a self-hosted runner from a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}
+
+### Delete a workflow run
+## Delete a workflow run
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}
+
+### Delete workflow run logs
+## Delete workflow run logs
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/logs
+Accept: application/json
+
+### Disable a selected repository for GitHub Actions in an organization
+## Disable a selected repository for GitHub Actions in an organization
+DELETE https://api.github.com/orgs/{{org}}/actions/permissions/repositories/{{repository_id}}
+
+### Disable a workflow
+## Disable a workflow
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/disable
+
+### Download an artifact
+## Download an artifact
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts/{{artifact_id}}/{{archive_format}}
+Accept: application/json
+
+### Download job logs for a workflow run
+## Download job logs for a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/jobs/{{job_id}}/logs
+
+### Download workflow run attempt logs
+## Download workflow run attempt logs
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/attempts/{{attempt_number}}/logs
+
+### Download workflow run logs
+## Download workflow run logs
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/logs
+
+### Enable a selected repository for GitHub Actions in an organization
+## Enable a selected repository for GitHub Actions in an organization
+PUT https://api.github.com/orgs/{{org}}/actions/permissions/repositories/{{repository_id}}
+
+### Enable a workflow
+## Enable a workflow
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/enable
+
+### Force cancel a workflow run
+## Force cancel a workflow run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/force-cancel
+Accept: application/json
+
+### Create configuration for a just-in-time runner for an organization
+## Create configuration for a just-in-time runner for an organization
+POST https://api.github.com/orgs/{{org}}/actions/runners/generate-jitconfig
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "New runner",
+ "runner_group_id" : 1,
+ "labels" : [ "self-hosted", "X64", "macOS", "no-gpu" ],
+ "work_folder" : "_work"
+}
+
+
+### Create configuration for a just-in-time runner for a repository
+## Create configuration for a just-in-time runner for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/generate-jitconfig
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "New runner",
+ "runner_group_id" : 1,
+ "labels" : [ "self-hosted", "X64", "macOS", "no-gpu" ],
+ "work_folder" : "_work"
+}
+
+
+### List GitHub Actions caches for a repository
+## List GitHub Actions caches for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/caches
+Accept: application/json
+
+### Get GitHub Actions cache usage for a repository
+## Get GitHub Actions cache usage for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/cache/usage
+Accept: application/json
+
+### List repositories with GitHub Actions cache usage for an organization
+## List repositories with GitHub Actions cache usage for an organization
+GET https://api.github.com/orgs/{{org}}/actions/cache/usage-by-repository
+Accept: application/json
+
+### Get GitHub Actions cache usage for an organization
+## Get GitHub Actions cache usage for an organization
+GET https://api.github.com/orgs/{{org}}/actions/cache/usage
+Accept: application/json
+
+### Get allowed actions and reusable workflows for an organization
+## Get allowed actions and reusable workflows for an organization
+GET https://api.github.com/orgs/{{org}}/actions/permissions/selected-actions
+Accept: application/json
+
+### Get allowed actions and reusable workflows for a repository
+## Get allowed actions and reusable workflows for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/selected-actions
+Accept: application/json
+
+### Get an artifact
+## Get an artifact
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts/{{artifact_id}}
+Accept: application/json
+
+### Get the customization template for an OIDC subject claim for a repository
+## Get the customization template for an OIDC subject claim for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/oidc/customization/sub
+Accept: application/json
+Accept: application/scim+json
+
+### Get an environment public key
+## Get an environment public key
+GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets/public-key
+Accept: application/json
+
+### Get an environment secret
+## Get an environment secret
+GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets/{{secret_name}}
+Accept: application/json
+
+### Get an environment variable
+## Get an environment variable
+GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables/{{name}}
+Accept: application/json
+
+### Get default workflow permissions for an organization
+## Get default workflow permissions for an organization
+GET https://api.github.com/orgs/{{org}}/actions/permissions/workflow
+Accept: application/json
+
+### Get default workflow permissions for a repository
+## Get default workflow permissions for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/workflow
+Accept: application/json
+
+### Get GitHub Actions permissions for an organization
+## Get GitHub Actions permissions for an organization
+GET https://api.github.com/orgs/{{org}}/actions/permissions
+Accept: application/json
+
+### Get GitHub Actions permissions for a repository
+## Get GitHub Actions permissions for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions
+Accept: application/json
+
+### Get a job for a workflow run
+## Get a job for a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/jobs/{{job_id}}
+Accept: application/json
+
+### Get an organization public key
+## Get an organization public key
+GET https://api.github.com/orgs/{{org}}/actions/secrets/public-key
+Accept: application/json
+
+### Get an organization secret
+## Get an organization secret
+GET https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}
+Accept: application/json
+
+### Get an organization variable
+## Get an organization variable
+GET https://api.github.com/orgs/{{org}}/actions/variables/{{name}}
+Accept: application/json
+
+### Get pending deployments for a workflow run
+## Get pending deployments for a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/pending_deployments
+Accept: application/json
+
+### Get a repository public key
+## Get a repository public key
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets/public-key
+Accept: application/json
+
+### Get a repository secret
+## Get a repository secret
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets/{{secret_name}}
+Accept: application/json
+
+### Get a repository variable
+## Get a repository variable
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables/{{name}}
+Accept: application/json
+
+### Get the review history for a workflow run
+## Get the review history for a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/approvals
+Accept: application/json
+
+### Get a self-hosted runner for an organization
+## Get a self-hosted runner for an organization
+GET https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}
+Accept: application/json
+
+### Get a self-hosted runner for a repository
+## Get a self-hosted runner for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}
+Accept: application/json
+
+### Get a workflow
+## Get a workflow
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}
+Accept: application/json
+
+### Get the level of access for workflows outside of the repository
+## Get the level of access for workflows outside of the repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/access
+Accept: application/json
+
+### Get a workflow run
+## Get a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}
+Accept: application/json
+
+### Get a workflow run attempt
+## Get a workflow run attempt
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/attempts/{{attempt_number}}
+Accept: application/json
+
+### Get workflow run usage
+## Get workflow run usage
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/timing
+Accept: application/json
+
+### Get workflow usage
+## Get workflow usage
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/timing
+Accept: application/json
+
+### List artifacts for a repository
+## List artifacts for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/artifacts
+Accept: application/json
+
+### List environment secrets
+## List environment secrets
+GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/secrets
+Accept: application/json
+
+### List environment variables
+## List environment variables
+GET https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables
+Accept: application/json
+
+### List jobs for a workflow run
+## List jobs for a workflow run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/jobs
+Accept: application/json
+
+### List jobs for a workflow run attempt
+## List jobs for a workflow run attempt
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/attempts/{{attempt_number}}/jobs
+Accept: application/json
+
+### List labels for a self-hosted runner for an organization
+## List labels for a self-hosted runner for an organization
+GET https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}/labels
+Accept: application/json
+
+### List labels for a self-hosted runner for a repository
+## List labels for a self-hosted runner for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}/labels
+Accept: application/json
+
+### List organization secrets
+## List organization secrets
+GET https://api.github.com/orgs/{{org}}/actions/secrets
+Accept: application/json
+
+### List organization variables
+## List organization variables
+GET https://api.github.com/orgs/{{org}}/actions/variables
+Accept: application/json
+
+### List repository organization secrets
+## List repository organization secrets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-secrets
+Accept: application/json
+
+### List repository organization variables
+## List repository organization variables
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/organization-variables
+Accept: application/json
+
+### List repository secrets
+## List repository secrets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/secrets
+Accept: application/json
+
+### List repository variables
+## List repository variables
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables
+Accept: application/json
+
+### List repository workflows
+## List repository workflows
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows
+Accept: application/json
+
+### List runner applications for an organization
+## List runner applications for an organization
+GET https://api.github.com/orgs/{{org}}/actions/runners/downloads
+Accept: application/json
+
+### List runner applications for a repository
+## List runner applications for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/downloads
+Accept: application/json
+
+### List selected repositories for an organization secret
+## List selected repositories for an organization secret
+GET https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}/repositories
+Accept: application/json
+
+### List selected repositories for an organization variable
+## List selected repositories for an organization variable
+GET https://api.github.com/orgs/{{org}}/actions/variables/{{name}}/repositories
+Accept: application/json
+
+### List selected repositories enabled for GitHub Actions in an organization
+## List selected repositories enabled for GitHub Actions in an organization
+GET https://api.github.com/orgs/{{org}}/actions/permissions/repositories
+Accept: application/json
+
+### List self-hosted runners for an organization
+## List self-hosted runners for an organization
+GET https://api.github.com/orgs/{{org}}/actions/runners
+Accept: application/json
+
+### List self-hosted runners for a repository
+## List self-hosted runners for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners
+Accept: application/json
+
+### List workflow run artifacts
+## List workflow run artifacts
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/artifacts
+Accept: application/json
+
+### List workflow runs for a workflow
+## List workflow runs for a workflow
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows/{{workflow_id}}/runs
+Accept: application/json
+
+### List workflow runs for a repository
+## List workflow runs for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs
+Accept: application/json
+
+
+
+
+### Remove all custom labels from a self-hosted runner for an organization
+## Remove all custom labels from a self-hosted runner for an organization
+DELETE https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}/labels
+Accept: application/json
+
+### Remove all custom labels from a self-hosted runner for a repository
+## Remove all custom labels from a self-hosted runner for a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}/labels
+Accept: application/json
+
+### Remove a custom label from a self-hosted runner for an organization
+## Remove a custom label from a self-hosted runner for an organization
+DELETE https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}/labels/{{name}}
+Accept: application/json
+
+### Remove a custom label from a self-hosted runner for a repository
+## Remove a custom label from a self-hosted runner for a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}/labels/{{name}}
+Accept: application/json
+
+### Remove selected repository from an organization secret
+## Remove selected repository from an organization secret
+DELETE https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}/repositories/{{repository_id}}
+
+### Remove selected repository from an organization variable
+## Remove selected repository from an organization variable
+DELETE https://api.github.com/orgs/{{org}}/actions/variables/{{name}}/repositories/{{repository_id}}
+
+### Review custom deployment protection rules for a workflow run
+## Review custom deployment protection rules for a workflow run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/deployment_protection_rule
+Content-Type: application/json
+
+{
+ "environment_name" : "prod-eus",
+ "state" : "approved",
+ "comment" : "All health checks passed."
+}
+
+
+### Review pending deployments for a workflow run
+## Review pending deployments for a workflow run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/actions/runs/{{run_id}}/pending_deployments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "environment_ids" : [ 161171787 ],
+ "state" : "approved",
+ "comment" : "Ship it!"
+}
+
+
+### Set allowed actions and reusable workflows for an organization
+##
+PUT https://api.github.com/orgs/{{org}}/actions/permissions/selected-actions
+Content-Type: application/json
+
+{
+ "github_owned_allowed" : true,
+ "verified_allowed" : false,
+ "patterns_allowed" : [ "monalisa/octocat@*", "docker/*" ]
+}
+
+
+### Set allowed actions and reusable workflows for a repository
+##
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/selected-actions
+Content-Type: application/json
+
+{
+ "github_owned_allowed" : true,
+ "verified_allowed" : false,
+ "patterns_allowed" : [ "monalisa/octocat@*", "docker/*" ]
+}
+
+
+### Set custom labels for a self-hosted runner for an organization
+## Set custom labels for a self-hosted runner for an organization
+PUT https://api.github.com/orgs/{{org}}/actions/runners/{{runner_id}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "gpu", "accelerated" ]
+}
+
+
+### Set custom labels for a self-hosted runner for a repository
+## Set custom labels for a self-hosted runner for a repository
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/runners/{{runner_id}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "gpu", "accelerated" ]
+}
+
+
+### Set the customization template for an OIDC subject claim for a repository
+## Set the customization template for an OIDC subject claim for a repository
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/oidc/customization/sub
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "use_default" : false,
+ "include_claim_keys" : [ "repo", "context" ]
+}
+
+
+### Set default workflow permissions for an organization
+## Give read-only permission, and allow approving PRs.
+PUT https://api.github.com/orgs/{{org}}/actions/permissions/workflow
+Content-Type: application/json
+
+{
+ "default_workflow_permissions" : "read",
+ "can_approve_pull_request_reviews" : true
+}
+
+
+### Set default workflow permissions for a repository
+## Give read-only permission, and allow approving PRs.
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/workflow
+Content-Type: application/json
+
+{
+ "default_workflow_permissions" : "read",
+ "can_approve_pull_request_reviews" : true
+}
+
+
+### Set GitHub Actions permissions for an organization
+## Set GitHub Actions permissions for an organization
+PUT https://api.github.com/orgs/{{org}}/actions/permissions
+Content-Type: application/json
+
+{
+ "enabled_repositories" : "all",
+ "allowed_actions" : "selected"
+}
+
+
+### Set GitHub Actions permissions for a repository
+## Set GitHub Actions permissions for a repository
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions
+Content-Type: application/json
+
+{
+ "enabled" : true,
+ "allowed_actions" : "selected"
+}
+
+
+### Set selected repositories for an organization secret
+## Set selected repositories for an organization secret
+PUT https://api.github.com/orgs/{{org}}/actions/secrets/{{secret_name}}/repositories
+Content-Type: application/json
+
+{
+ "selected_repository_ids" : [ 64780797 ]
+}
+
+
+### Set selected repositories for an organization variable
+## Set selected repositories for an organization variable
+PUT https://api.github.com/orgs/{{org}}/actions/variables/{{name}}/repositories
+Content-Type: application/json
+
+{
+ "selected_repository_ids" : [ 64780797 ]
+}
+
+
+### Set selected repositories enabled for GitHub Actions in an organization
+## Set selected repositories enabled for GitHub Actions in an organization
+PUT https://api.github.com/orgs/{{org}}/actions/permissions/repositories
+Content-Type: application/json
+
+{
+ "selected_repository_ids" : [ 32, 42 ]
+}
+
+
+### Set the level of access for workflows outside of the repository
+##
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/actions/permissions/access
+Content-Type: application/json
+
+{
+ "access_level" : "organization"
+}
+
+
+### Update an environment variable
+## Update an environment variable
+PATCH https://api.github.com/repositories/{{repository_id}}/environments/{{environment_name}}/variables/{{name}}
+Content-Type: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat"
+}
+
+
+### Update an organization variable
+## Update an organization variable
+PATCH https://api.github.com/orgs/{{org}}/actions/variables/{{name}}
+Content-Type: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat",
+ "visibility" : "selected",
+ "selected_repository_ids" : [ 1296269, 1296280 ]
+}
+
+
+### Update a repository variable
+## Update a repository variable
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/actions/variables/{{name}}
+Content-Type: application/json
+
+{
+ "name" : "USERNAME",
+ "value" : "octocat"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/ActivityApi.http b/samples/client/github/jetbrains/http/client/Apis/ActivityApi.http
new file mode 100644
index 000000000000..6ed76c69d669
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ActivityApi.http
@@ -0,0 +1,186 @@
+## ActivityApi
+
+### Check if a repository is starred by the authenticated user
+## Check if a repository is starred by the authenticated user
+GET https://api.github.com/user/starred/{{owner}}/{{repo}}
+Accept: application/json
+
+### Delete a repository subscription
+## Delete a repository subscription
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/subscription
+
+### Delete a thread subscription
+## Delete a thread subscription
+DELETE https://api.github.com/notifications/threads/{{thread_id}}/subscription
+Accept: application/json
+
+### Get feeds
+## Get feeds
+GET https://api.github.com/feeds
+Accept: application/json
+
+### Get a repository subscription
+## Get a repository subscription
+GET https://api.github.com/repos/{{owner}}/{{repo}}/subscription
+Accept: application/json
+
+### Get a thread
+## Get a thread
+GET https://api.github.com/notifications/threads/{{thread_id}}
+Accept: application/json
+
+### Get a thread subscription for the authenticated user
+## Get a thread subscription for the authenticated user
+GET https://api.github.com/notifications/threads/{{thread_id}}/subscription
+Accept: application/json
+
+### List events for the authenticated user
+## List events for the authenticated user
+GET https://api.github.com/users/{{username}}/events
+Accept: application/json
+
+### List notifications for the authenticated user
+## List notifications for the authenticated user
+GET https://api.github.com/notifications
+Accept: application/json
+
+### List organization events for the authenticated user
+## List organization events for the authenticated user
+GET https://api.github.com/users/{{username}}/events/orgs/{{org}}
+Accept: application/json
+
+### List public events
+## List public events
+GET https://api.github.com/events
+Accept: application/json
+
+### List public events for a network of repositories
+## List public events for a network of repositories
+GET https://api.github.com/networks/{{owner}}/{{repo}}/events
+Accept: application/json
+
+### List public events for a user
+## List public events for a user
+GET https://api.github.com/users/{{username}}/events/public
+Accept: application/json
+
+### List public organization events
+## List public organization events
+GET https://api.github.com/orgs/{{org}}/events
+Accept: application/json
+
+### List events received by the authenticated user
+## List events received by the authenticated user
+GET https://api.github.com/users/{{username}}/received_events
+Accept: application/json
+
+### List public events received by a user
+## List public events received by a user
+GET https://api.github.com/users/{{username}}/received_events/public
+Accept: application/json
+
+### List repository events
+## List repository events
+GET https://api.github.com/repos/{{owner}}/{{repo}}/events
+Accept: application/json
+
+### List repository notifications for the authenticated user
+## List repository notifications for the authenticated user
+GET https://api.github.com/repos/{{owner}}/{{repo}}/notifications
+Accept: application/json
+
+### List repositories starred by the authenticated user
+## List repositories starred by the authenticated user
+GET https://api.github.com/user/starred
+Accept: application/json
+Accept: application/vnd.github.v3.star+json
+
+### List repositories starred by a user
+## List repositories starred by a user
+GET https://api.github.com/users/{{username}}/starred
+Accept: application/json
+
+### List repositories watched by a user
+## List repositories watched by a user
+GET https://api.github.com/users/{{username}}/subscriptions
+Accept: application/json
+
+### List stargazers
+## List stargazers
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stargazers
+Accept: application/json
+
+### List repositories watched by the authenticated user
+## List repositories watched by the authenticated user
+GET https://api.github.com/user/subscriptions
+Accept: application/json
+
+### List watchers
+## List watchers
+GET https://api.github.com/repos/{{owner}}/{{repo}}/subscribers
+Accept: application/json
+
+### Mark notifications as read
+## Mark notifications as read
+PUT https://api.github.com/notifications
+Content-Type: application/json
+Accept: application/json
+
+{
+ "last_read_at" : "2022-06-10T00:00:00Z",
+ "read" : true
+}
+
+
+### Mark repository notifications as read
+## Mark repository notifications as read
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/notifications
+Content-Type: application/json
+Accept: application/json
+
+{
+ "last_read_at" : "2019-01-01T00:00:00Z"
+}
+
+
+### Mark a thread as done
+## Mark a thread as done
+DELETE https://api.github.com/notifications/threads/{{thread_id}}
+
+### Mark a thread as read
+## Mark a thread as read
+PATCH https://api.github.com/notifications/threads/{{thread_id}}
+Accept: application/json
+
+### Set a repository subscription
+## Set a repository subscription
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/subscription
+Content-Type: application/json
+Accept: application/json
+
+{
+ "subscribed" : true,
+ "ignored" : false
+}
+
+
+### Set a thread subscription
+## Set a thread subscription
+PUT https://api.github.com/notifications/threads/{{thread_id}}/subscription
+Content-Type: application/json
+Accept: application/json
+
+{
+ "ignored" : false
+}
+
+
+### Star a repository for the authenticated user
+## Star a repository for the authenticated user
+PUT https://api.github.com/user/starred/{{owner}}/{{repo}}
+Accept: application/json
+
+### Unstar a repository for the authenticated user
+## Unstar a repository for the authenticated user
+DELETE https://api.github.com/user/starred/{{owner}}/{{repo}}
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/AppsApi.http b/samples/client/github/jetbrains/http/client/Apis/AppsApi.http
new file mode 100644
index 000000000000..1bf8d496f5a6
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/AppsApi.http
@@ -0,0 +1,243 @@
+## AppsApi
+
+### Add a repository to an app installation
+## Add a repository to an app installation
+PUT https://api.github.com/user/installations/{{installation_id}}/repositories/{{repository_id}}
+Accept: application/json
+
+### Check a token
+## Check a token
+POST https://api.github.com/applications/{{client_id}}/token
+Content-Type: application/json
+Accept: application/json
+
+{
+ "access_token" : "e72e16c7e42f292c6912e7710c838347ae178b4a"
+}
+
+
+### Create a GitHub App from a manifest
+## Create a GitHub App from a manifest
+POST https://api.github.com/app-manifests/{{code}}/conversions
+Accept: application/json
+
+### Create an installation access token for an app
+## Create an installation access token for an app
+POST https://api.github.com/app/installations/{{installation_id}}/access_tokens
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repositories" : [ "Hello-World" ],
+ "permissions" : {
+ "issues" : "write",
+ "contents" : "read"
+ }
+}
+
+
+### Delete an app authorization
+## Delete an app authorization
+DELETE https://api.github.com/applications/{{client_id}}/grant
+Content-Type: application/json
+Accept: application/json
+
+{
+ "access_token" : "e72e16c7e42f292c6912e7710c838347ae178b4a"
+}
+
+
+### Delete an installation for the authenticated app
+## Delete an installation for the authenticated app
+DELETE https://api.github.com/app/installations/{{installation_id}}
+Accept: application/json
+
+### Delete an app token
+## Delete an app token
+DELETE https://api.github.com/applications/{{client_id}}/token
+Content-Type: application/json
+Accept: application/json
+
+{
+ "access_token" : "e72e16c7e42f292c6912e7710c838347ae178b4a"
+}
+
+
+### Get the authenticated app
+## Get the authenticated app
+GET https://api.github.com/app
+Accept: application/json
+
+### Get an app
+## Get an app
+GET https://api.github.com/apps/{{app_slug}}
+Accept: application/json
+
+### Get an installation for the authenticated app
+## Get an installation for the authenticated app
+GET https://api.github.com/app/installations/{{installation_id}}
+Accept: application/json
+
+### Get an organization installation for the authenticated app
+## Get an organization installation for the authenticated app
+GET https://api.github.com/orgs/{{org}}/installation
+Accept: application/json
+
+### Get a repository installation for the authenticated app
+## Get a repository installation for the authenticated app
+GET https://api.github.com/repos/{{owner}}/{{repo}}/installation
+Accept: application/json
+
+### Get a subscription plan for an account
+## Get a subscription plan for an account
+GET https://api.github.com/marketplace_listing/accounts/{{account_id}}
+Accept: application/json
+
+### Get a subscription plan for an account (stubbed)
+## Get a subscription plan for an account (stubbed)
+GET https://api.github.com/marketplace_listing/stubbed/accounts/{{account_id}}
+Accept: application/json
+
+### Get a user installation for the authenticated app
+## Get a user installation for the authenticated app
+GET https://api.github.com/users/{{username}}/installation
+Accept: application/json
+
+### Get a webhook configuration for an app
+## Get a webhook configuration for an app
+GET https://api.github.com/app/hook/config
+Accept: application/json
+
+### Get a delivery for an app webhook
+## Get a delivery for an app webhook
+GET https://api.github.com/app/hook/deliveries/{{delivery_id}}
+Accept: application/json
+Accept: application/scim+json
+
+### List accounts for a plan
+## List accounts for a plan
+GET https://api.github.com/marketplace_listing/plans/{{plan_id}}/accounts
+Accept: application/json
+
+### List accounts for a plan (stubbed)
+## List accounts for a plan (stubbed)
+GET https://api.github.com/marketplace_listing/stubbed/plans/{{plan_id}}/accounts
+Accept: application/json
+
+### List repositories accessible to the user access token
+## List repositories accessible to the user access token
+GET https://api.github.com/user/installations/{{installation_id}}/repositories
+Accept: application/json
+
+### List installation requests for the authenticated app
+## List installation requests for the authenticated app
+GET https://api.github.com/app/installation-requests
+Accept: application/json
+
+### List installations for the authenticated app
+## List installations for the authenticated app
+GET https://api.github.com/app/installations
+Accept: application/json
+
+### List app installations accessible to the user access token
+## List app installations accessible to the user access token
+GET https://api.github.com/user/installations
+Accept: application/json
+
+### List plans
+## List plans
+GET https://api.github.com/marketplace_listing/plans
+Accept: application/json
+
+### List plans (stubbed)
+## List plans (stubbed)
+GET https://api.github.com/marketplace_listing/stubbed/plans
+Accept: application/json
+
+### List repositories accessible to the app installation
+## List repositories accessible to the app installation
+GET https://api.github.com/installation/repositories
+Accept: application/json
+
+### List subscriptions for the authenticated user
+## List subscriptions for the authenticated user
+GET https://api.github.com/user/marketplace_purchases
+Accept: application/json
+
+### List subscriptions for the authenticated user (stubbed)
+## List subscriptions for the authenticated user (stubbed)
+GET https://api.github.com/user/marketplace_purchases/stubbed
+Accept: application/json
+
+### List deliveries for an app webhook
+## List deliveries for an app webhook
+GET https://api.github.com/app/hook/deliveries
+Accept: application/json
+Accept: application/scim+json
+
+### Redeliver a delivery for an app webhook
+## Redeliver a delivery for an app webhook
+POST https://api.github.com/app/hook/deliveries/{{delivery_id}}/attempts
+Accept: application/json
+Accept: application/scim+json
+
+### Remove a repository from an app installation
+## Remove a repository from an app installation
+DELETE https://api.github.com/user/installations/{{installation_id}}/repositories/{{repository_id}}
+Accept: application/json
+
+### Reset a token
+## Reset a token
+PATCH https://api.github.com/applications/{{client_id}}/token
+Content-Type: application/json
+Accept: application/json
+
+{
+ "access_token" : "e72e16c7e42f292c6912e7710c838347ae178b4a"
+}
+
+
+### Revoke an installation access token
+## Revoke an installation access token
+DELETE https://api.github.com/installation/token
+
+### Create a scoped access token
+## Create a scoped access token
+POST https://api.github.com/applications/{{client_id}}/token/scoped
+Content-Type: application/json
+Accept: application/json
+
+{
+ "access_token" : "e72e16c7e42f292c6912e7710c838347ae178b4a",
+ "target" : "octocat",
+ "permissions" : {
+ "metadata" : "read",
+ "issues" : "write",
+ "contents" : "read"
+ }
+}
+
+
+### Suspend an app installation
+## Suspend an app installation
+PUT https://api.github.com/app/installations/{{installation_id}}/suspended
+Accept: application/json
+
+### Unsuspend an app installation
+## Unsuspend an app installation
+DELETE https://api.github.com/app/installations/{{installation_id}}/suspended
+Accept: application/json
+
+### Update a webhook configuration for an app
+## Update a webhook configuration for an app
+PATCH https://api.github.com/app/hook/config
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content_type" : "json",
+ "insecure_ssl" : "0",
+ "secret" : "********",
+ "url" : "https://example.com/webhook"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/BillingApi.http b/samples/client/github/jetbrains/http/client/Apis/BillingApi.http
new file mode 100644
index 000000000000..58f85466fda4
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/BillingApi.http
@@ -0,0 +1,31 @@
+## BillingApi
+
+### Get GitHub Actions billing for an organization
+## Get GitHub Actions billing for an organization
+GET https://api.github.com/orgs/{{org}}/settings/billing/actions
+Accept: application/json
+
+### Get GitHub Actions billing for a user
+## Get GitHub Actions billing for a user
+GET https://api.github.com/users/{{username}}/settings/billing/actions
+Accept: application/json
+
+### Get GitHub Packages billing for an organization
+## Get GitHub Packages billing for an organization
+GET https://api.github.com/orgs/{{org}}/settings/billing/packages
+Accept: application/json
+
+### Get GitHub Packages billing for a user
+## Get GitHub Packages billing for a user
+GET https://api.github.com/users/{{username}}/settings/billing/packages
+Accept: application/json
+
+### Get shared storage billing for an organization
+## Get shared storage billing for an organization
+GET https://api.github.com/orgs/{{org}}/settings/billing/shared-storage
+Accept: application/json
+
+### Get shared storage billing for a user
+## Get shared storage billing for a user
+GET https://api.github.com/users/{{username}}/settings/billing/shared-storage
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/ChecksApi.http b/samples/client/github/jetbrains/http/client/Apis/ChecksApi.http
new file mode 100644
index 000000000000..f066b958182a
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ChecksApi.http
@@ -0,0 +1,127 @@
+## ChecksApi
+
+### Create a check run
+## Create a check run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/check-runs
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "mighty_readme",
+ "head_sha" : "ce587453ced02b1526dfb4cb910479d431683101",
+ "status" : "in_progress",
+ "external_id" : "42",
+ "started_at" : "2018-05-04T01:14:52Z",
+ "output" : {
+ "title" : "Mighty Readme report",
+ "summary" : "",
+ "text" : ""
+ }
+}
+
+
+### Create a check suite
+## Create a check suite
+POST https://api.github.com/repos/{{owner}}/{{repo}}/check-suites
+Content-Type: application/json
+Accept: application/json
+
+{
+ "head_sha" : "d6fde92930d4715a2b49857d24b940956b26d2d3"
+}
+
+
+### Get a check run
+## Get a check run
+GET https://api.github.com/repos/{{owner}}/{{repo}}/check-runs/{{check_run_id}}
+Accept: application/json
+
+### Get a check suite
+## Get a check suite
+GET https://api.github.com/repos/{{owner}}/{{repo}}/check-suites/{{check_suite_id}}
+Accept: application/json
+
+### List check run annotations
+## List check run annotations
+GET https://api.github.com/repos/{{owner}}/{{repo}}/check-runs/{{check_run_id}}/annotations
+Accept: application/json
+
+### List check runs for a Git reference
+## List check runs for a Git reference
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/check-runs
+Accept: application/json
+
+### List check runs in a check suite
+## List check runs in a check suite
+GET https://api.github.com/repos/{{owner}}/{{repo}}/check-suites/{{check_suite_id}}/check-runs
+Accept: application/json
+
+### List check suites for a Git reference
+## List check suites for a Git reference
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/check-suites
+Accept: application/json
+
+### Rerequest a check run
+## Rerequest a check run
+POST https://api.github.com/repos/{{owner}}/{{repo}}/check-runs/{{check_run_id}}/rerequest
+Accept: application/json
+
+### Rerequest a check suite
+## Rerequest a check suite
+POST https://api.github.com/repos/{{owner}}/{{repo}}/check-suites/{{check_suite_id}}/rerequest
+Accept: application/json
+
+### Update repository preferences for check suites
+## Update repository preferences for check suites
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/check-suites/preferences
+Content-Type: application/json
+Accept: application/json
+
+{
+ "auto_trigger_checks" : [ {
+ "app_id" : 4,
+ "setting" : false
+ } ]
+}
+
+
+### Update a check run
+## Update a check run
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/check-runs/{{check_run_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "mighty_readme",
+ "started_at" : "2018-05-04T01:14:52Z",
+ "status" : "completed",
+ "conclusion" : "success",
+ "completed_at" : "2018-05-04T01:14:52Z",
+ "output" : {
+ "title" : "Mighty Readme report",
+ "summary" : "There are 0 failures, 2 warnings, and 1 notices.",
+ "text" : "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations" : [ {
+ "path" : "README.md",
+ "annotation_level" : "warning",
+ "title" : "Spell Checker",
+ "message" : "Check your spelling for 'banaas'.",
+ "raw_details" : "Do you mean 'bananas' or 'banana'?",
+ "start_line" : 2,
+ "end_line" : 2
+ }, {
+ "path" : "README.md",
+ "annotation_level" : "warning",
+ "title" : "Spell Checker",
+ "message" : "Check your spelling for 'aples'",
+ "raw_details" : "Do you mean 'apples' or 'Naples'",
+ "start_line" : 4,
+ "end_line" : 4
+ } ],
+ "images" : [ {
+ "alt" : "Super bananas",
+ "image_url" : "http://example.com/images/42"
+ } ]
+ }
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/ClassroomApi.http b/samples/client/github/jetbrains/http/client/Apis/ClassroomApi.http
new file mode 100644
index 000000000000..187f091d314f
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ClassroomApi.http
@@ -0,0 +1,31 @@
+## ClassroomApi
+
+### Get a classroom
+## Get a classroom
+GET https://api.github.com/classrooms/{{classroom_id}}
+Accept: application/json
+
+### Get an assignment
+## Get an assignment
+GET https://api.github.com/assignments/{{assignment_id}}
+Accept: application/json
+
+### Get assignment grades
+## Get assignment grades
+GET https://api.github.com/assignments/{{assignment_id}}/grades
+Accept: application/json
+
+### List accepted assignments for an assignment
+## List accepted assignments for an assignment
+GET https://api.github.com/assignments/{{assignment_id}}/accepted_assignments
+Accept: application/json
+
+### List assignments for a classroom
+## List assignments for a classroom
+GET https://api.github.com/classrooms/{{classroom_id}}/assignments
+Accept: application/json
+
+### List classrooms
+## List classrooms
+GET https://api.github.com/classrooms
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/CodeScanningApi.http b/samples/client/github/jetbrains/http/client/Apis/CodeScanningApi.http
new file mode 100644
index 000000000000..1048d45688f0
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/CodeScanningApi.http
@@ -0,0 +1,95 @@
+## CodeScanningApi
+
+### Delete a code scanning analysis from a repository
+## Delete a code scanning analysis from a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/analyses/{{analysis_id}}
+Accept: application/json
+Accept: application/scim+json
+
+### Get a code scanning alert
+## Get a code scanning alert
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts/{{alert_number}}
+Accept: application/json
+
+### Get a code scanning analysis for a repository
+## Get a code scanning analysis for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/analyses/{{analysis_id}}
+Accept: application/json
+Accept: application/json+sarif
+
+### Get a CodeQL database for a repository
+## Get a CodeQL database for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/codeql/databases/{{language}}
+Accept: application/json
+
+### Get a code scanning default setup configuration
+## Get a code scanning default setup configuration
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/default-setup
+Accept: application/json
+
+### Get information about a SARIF upload
+## Get information about a SARIF upload
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/sarifs/{{sarif_id}}
+Accept: application/json
+
+### List instances of a code scanning alert
+## List instances of a code scanning alert
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts/{{alert_number}}/instances
+Accept: application/json
+
+### List code scanning alerts for an organization
+## List code scanning alerts for an organization
+GET https://api.github.com/orgs/{{org}}/code-scanning/alerts
+Accept: application/json
+
+### List code scanning alerts for a repository
+## List code scanning alerts for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts
+Accept: application/json
+
+### List CodeQL databases for a repository
+## List CodeQL databases for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/codeql/databases
+Accept: application/json
+
+### List code scanning analyses for a repository
+## List code scanning analyses for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/analyses
+Accept: application/json
+
+### Update a code scanning alert
+## Update a code scanning alert
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/alerts/{{alert_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "state" : "dismissed",
+ "dismissed_reason" : "false positive",
+ "dismissed_comment" : "This alert is not actually correct, because there's a sanitizer included in the library."
+}
+
+
+### Update a code scanning default setup configuration
+##
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/default-setup
+Content-Type: application/json
+Accept: application/json
+
+{
+ "state" : "configured"
+}
+
+
+### Upload an analysis as SARIF data
+## Upload an analysis as SARIF data
+POST https://api.github.com/repos/{{owner}}/{{repo}}/code-scanning/sarifs
+Content-Type: application/json
+Accept: application/json
+
+{
+ "commit_sha" : "4b6472266afd7b471e86085a6659e8c7f2b119da",
+ "ref" : "refs/heads/master",
+ "sarif" : "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/CodesOfConductApi.http b/samples/client/github/jetbrains/http/client/Apis/CodesOfConductApi.http
new file mode 100644
index 000000000000..37a0c1796386
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/CodesOfConductApi.http
@@ -0,0 +1,11 @@
+## CodesOfConductApi
+
+### Get all codes of conduct
+## Get all codes of conduct
+GET https://api.github.com/codes_of_conduct
+Accept: application/json
+
+### Get a code of conduct
+## Get a code of conduct
+GET https://api.github.com/codes_of_conduct/{{key}}
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/CodespacesApi.http b/samples/client/github/jetbrains/http/client/Apis/CodespacesApi.http
new file mode 100644
index 000000000000..466b9529358a
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/CodespacesApi.http
@@ -0,0 +1,332 @@
+## CodespacesApi
+
+### Add a selected repository to a user secret
+## Add a selected repository to a user secret
+PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
+Accept: application/json
+
+### Add selected repository to an organization secret
+## Add selected repository to an organization secret
+PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
+Accept: application/json
+
+### Check if permissions defined by a devcontainer have been accepted by the authenticated user
+## Check if permissions defined by a devcontainer have been accepted by the authenticated user
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/permissions_check
+Accept: application/json
+
+### List machine types for a codespace
+## List machine types for a codespace
+GET https://api.github.com/user/codespaces/{{codespace_name}}/machines
+Accept: application/json
+
+### Create a codespace for the authenticated user
+## Create a codespace for the authenticated user
+POST https://api.github.com/user/codespaces
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repository_id" : 1,
+ "ref" : "main",
+ "geo" : "UsWest"
+}
+
+
+### Create or update an organization secret
+## Create or update an organization secret
+PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678",
+ "visibility" : "selected",
+ "selected_repository_ids" : [ 1296269, 1296280 ]
+}
+
+
+### Create or update a repository secret
+## Create or update a repository secret
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678"
+}
+
+
+### Create or update a secret for the authenticated user
+## Create or update a secret for the authenticated user
+PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678",
+ "selected_repository_ids" : [ "1234567", "2345678" ]
+}
+
+
+### Create a codespace from a pull request
+## Create a codespace from a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/codespaces
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repository_id" : 1,
+ "ref" : "main"
+}
+
+
+### Create a codespace in a repository
+## Create a codespace in a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/codespaces
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "ref" : "main",
+ "machine" : "standardLinux32gb"
+}
+
+
+### Remove users from Codespaces access for an organization
+## Remove users from Codespaces access for an organization
+DELETE https://api.github.com/orgs/{{org}}/codespaces/access/selected_users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_usernames" : [ "johnDoe", "atomIO" ]
+}
+
+
+### Delete a codespace for the authenticated user
+## Delete a codespace for the authenticated user
+DELETE https://api.github.com/user/codespaces/{{codespace_name}}
+Accept: application/json
+
+### Delete a codespace from the organization
+## Delete a codespace from the organization
+DELETE https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces/{{codespace_name}}
+Accept: application/json
+
+### Delete an organization secret
+## Delete an organization secret
+DELETE https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
+Accept: application/json
+
+### Delete a repository secret
+## Delete a repository secret
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
+
+### Delete a secret for the authenticated user
+## Delete a secret for the authenticated user
+DELETE https://api.github.com/user/codespaces/secrets/{{secret_name}}
+
+### Export a codespace for the authenticated user
+## Export a codespace for the authenticated user
+POST https://api.github.com/user/codespaces/{{codespace_name}}/exports
+Accept: application/json
+
+### List codespaces for a user in organization
+## List codespaces for a user in organization
+GET https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces
+Accept: application/json
+
+### Get details about a codespace export
+## Get details about a codespace export
+GET https://api.github.com/user/codespaces/{{codespace_name}}/exports/{{export_id}}
+Accept: application/json
+
+### Get a codespace for the authenticated user
+## Get a codespace for the authenticated user
+GET https://api.github.com/user/codespaces/{{codespace_name}}
+Accept: application/json
+
+### Get an organization public key
+## Get an organization public key
+GET https://api.github.com/orgs/{{org}}/codespaces/secrets/public-key
+Accept: application/json
+
+### Get an organization secret
+## Get an organization secret
+GET https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
+Accept: application/json
+
+### Get public key for the authenticated user
+## Get public key for the authenticated user
+GET https://api.github.com/user/codespaces/secrets/public-key
+Accept: application/json
+
+### Get a repository public key
+## Get a repository public key
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/public-key
+Accept: application/json
+
+### Get a repository secret
+## Get a repository secret
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
+Accept: application/json
+
+### Get a secret for the authenticated user
+## Get a secret for the authenticated user
+GET https://api.github.com/user/codespaces/secrets/{{secret_name}}
+Accept: application/json
+
+### List devcontainer configurations in a repository for the authenticated user
+## List devcontainer configurations in a repository for the authenticated user
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/devcontainers
+Accept: application/json
+Accept: application/scim+json
+
+### List codespaces for the authenticated user
+## List codespaces for the authenticated user
+GET https://api.github.com/user/codespaces
+Accept: application/json
+
+### List codespaces for the organization
+## List codespaces for the organization
+GET https://api.github.com/orgs/{{org}}/codespaces
+Accept: application/json
+
+### List codespaces in a repository for the authenticated user
+## List codespaces in a repository for the authenticated user
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces
+Accept: application/json
+
+### List organization secrets
+## List organization secrets
+GET https://api.github.com/orgs/{{org}}/codespaces/secrets
+Accept: application/json
+
+### List repository secrets
+## List repository secrets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets
+Accept: application/json
+
+### List selected repositories for a user secret
+## List selected repositories for a user secret
+GET https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories
+Accept: application/json
+
+### List secrets for the authenticated user
+## List secrets for the authenticated user
+GET https://api.github.com/user/codespaces/secrets
+Accept: application/json
+
+### List selected repositories for an organization secret
+## List selected repositories for an organization secret
+GET https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories
+Accept: application/json
+
+### Get default attributes for a codespace
+## Get default attributes for a codespace
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/new
+Accept: application/json
+
+### Create a repository from an unpublished codespace
+## Create a repository from an unpublished codespace
+POST https://api.github.com/user/codespaces/{{codespace_name}}/publish
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repository" : "monalisa-octocat-hello-world-g4wpq6h95q",
+ "private" : false
+}
+
+
+### Remove a selected repository from a user secret
+## Remove a selected repository from a user secret
+DELETE https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
+Accept: application/json
+
+### Remove selected repository from an organization secret
+## Remove selected repository from an organization secret
+DELETE https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
+Accept: application/json
+
+### List available machine types for a repository
+## List available machine types for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/machines
+Accept: application/json
+
+### Manage access control for organization codespaces
+## Manage access control for organization codespaces
+PUT https://api.github.com/orgs/{{org}}/codespaces/access
+Content-Type: application/json
+Accept: application/json
+
+{
+ "visibility" : "selected_members",
+ "selected_usernames" : [ "johnDoe", "atomIO" ]
+}
+
+
+### Add users to Codespaces access for an organization
+## Add users to Codespaces access for an organization
+POST https://api.github.com/orgs/{{org}}/codespaces/access/selected_users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_usernames" : [ "johnDoe", "atomIO" ]
+}
+
+
+### Set selected repositories for a user secret
+## Set selected repositories for a user secret
+PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_repository_ids" : [ "1296269", "1296280" ]
+}
+
+
+### Set selected repositories for an organization secret
+## Set selected repositories for an organization secret
+PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_repository_ids" : [ 64780797 ]
+}
+
+
+### Start a codespace for the authenticated user
+## Start a codespace for the authenticated user
+POST https://api.github.com/user/codespaces/{{codespace_name}}/start
+Accept: application/json
+Accept: application/scim+json
+
+### Stop a codespace for the authenticated user
+## Stop a codespace for the authenticated user
+POST https://api.github.com/user/codespaces/{{codespace_name}}/stop
+Accept: application/json
+
+### Stop a codespace for an organization user
+## Stop a codespace for an organization user
+POST https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces/{{codespace_name}}/stop
+Accept: application/json
+
+### Update a codespace for the authenticated user
+## Update a codespace for the authenticated user
+PATCH https://api.github.com/user/codespaces/{{codespace_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "machine" : "standardLinux"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/CopilotApi.http b/samples/client/github/jetbrains/http/client/Apis/CopilotApi.http
new file mode 100644
index 000000000000..405ce68f3db9
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/CopilotApi.http
@@ -0,0 +1,60 @@
+## CopilotApi
+
+### Add teams to the Copilot subscription for an organization
+## Add teams to the Copilot subscription for an organization
+POST https://api.github.com/orgs/{{org}}/copilot/billing/selected_teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_teams" : [ "engteam1", "engteam2", "engteam3" ]
+}
+
+
+### Add users to the Copilot subscription for an organization
+## Add users to the Copilot subscription for an organization
+POST https://api.github.com/orgs/{{org}}/copilot/billing/selected_users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_usernames" : [ "cooluser1", "hacker2", "octocat" ]
+}
+
+
+### Remove teams from the Copilot subscription for an organization
+## Remove teams from the Copilot subscription for an organization
+DELETE https://api.github.com/orgs/{{org}}/copilot/billing/selected_teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_teams" : [ "engteam1", "engteam2", "engteam3" ]
+}
+
+
+### Remove users from the Copilot subscription for an organization
+## Remove users from the Copilot subscription for an organization
+DELETE https://api.github.com/orgs/{{org}}/copilot/billing/selected_users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "selected_usernames" : [ "cooluser1", "hacker2", "octocat" ]
+}
+
+
+### Get Copilot seat information and settings for an organization
+## Get Copilot seat information and settings for an organization
+GET https://api.github.com/orgs/{{org}}/copilot/billing
+Accept: application/json
+
+### Get Copilot seat assignment details for a user
+## Get Copilot seat assignment details for a user
+GET https://api.github.com/orgs/{{org}}/members/{{username}}/copilot
+Accept: application/json
+
+### List all Copilot seat assignments for an organization
+## List all Copilot seat assignments for an organization
+GET https://api.github.com/orgs/{{org}}/copilot/billing/seats
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/DependabotApi.http b/samples/client/github/jetbrains/http/client/Apis/DependabotApi.http
new file mode 100644
index 000000000000..1602fb71e3c9
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/DependabotApi.http
@@ -0,0 +1,124 @@
+## DependabotApi
+
+### Add selected repository to an organization secret
+## Add selected repository to an organization secret
+PUT https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}/repositories/{{repository_id}}
+
+### Create or update an organization secret
+## Create or update an organization secret
+PUT https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678",
+ "visibility" : "selected",
+ "selected_repository_ids" : [ "1296269", "1296280" ]
+}
+
+
+### Create or update a repository secret
+## Create or update a repository secret
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets/{{secret_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "encrypted_value" : "c2VjcmV0",
+ "key_id" : "012345678912345678"
+}
+
+
+### Delete an organization secret
+## Delete an organization secret
+DELETE https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}
+
+### Delete a repository secret
+## Delete a repository secret
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets/{{secret_name}}
+
+### Get a Dependabot alert
+## Get a Dependabot alert
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/alerts/{{alert_number}}
+Accept: application/json
+
+### Get an organization public key
+## Get an organization public key
+GET https://api.github.com/orgs/{{org}}/dependabot/secrets/public-key
+Accept: application/json
+
+### Get an organization secret
+## Get an organization secret
+GET https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}
+Accept: application/json
+
+### Get a repository public key
+## Get a repository public key
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets/public-key
+Accept: application/json
+
+### Get a repository secret
+## Get a repository secret
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets/{{secret_name}}
+Accept: application/json
+
+### List Dependabot alerts for an enterprise
+## List Dependabot alerts for an enterprise
+GET https://api.github.com/enterprises/{{enterprise}}/dependabot/alerts
+Accept: application/json
+
+### List Dependabot alerts for an organization
+## List Dependabot alerts for an organization
+GET https://api.github.com/orgs/{{org}}/dependabot/alerts
+Accept: application/json
+Accept: application/scim+json
+
+### List Dependabot alerts for a repository
+## List Dependabot alerts for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/alerts
+Accept: application/json
+Accept: application/scim+json
+
+### List organization secrets
+## List organization secrets
+GET https://api.github.com/orgs/{{org}}/dependabot/secrets
+Accept: application/json
+
+### List repository secrets
+## List repository secrets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/secrets
+Accept: application/json
+
+### List selected repositories for an organization secret
+## List selected repositories for an organization secret
+GET https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}/repositories
+Accept: application/json
+
+### Remove selected repository from an organization secret
+## Remove selected repository from an organization secret
+DELETE https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}/repositories/{{repository_id}}
+
+### Set selected repositories for an organization secret
+## Set selected repositories for an organization secret
+PUT https://api.github.com/orgs/{{org}}/dependabot/secrets/{{secret_name}}/repositories
+Content-Type: application/json
+
+{
+ "selected_repository_ids" : [ 64780797 ]
+}
+
+
+### Update a Dependabot alert
+## Update a Dependabot alert
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/dependabot/alerts/{{alert_number}}
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "state" : "dismissed",
+ "dismissed_reason" : "tolerable_risk",
+ "dismissed_comment" : "This alert is accurate but we use a sanitizer."
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/DependencyGraphApi.http b/samples/client/github/jetbrains/http/client/Apis/DependencyGraphApi.http
new file mode 100644
index 000000000000..50698db6064a
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/DependencyGraphApi.http
@@ -0,0 +1,55 @@
+## DependencyGraphApi
+
+### Create a snapshot of dependencies for a repository
+##
+POST https://api.github.com/repos/{{owner}}/{{repo}}/dependency-graph/snapshots
+Content-Type: application/json
+Accept: application/json
+
+{
+ "version" : 0,
+ "sha" : "ce587453ced02b1526dfb4cb910479d431683101",
+ "ref" : "refs/heads/main",
+ "job" : {
+ "correlator" : "yourworkflowname_youractionname",
+ "id" : "yourrunid"
+ },
+ "detector" : {
+ "name" : "octo-detector",
+ "version" : "0.0.1",
+ "url" : "https://github.com/octo-org/octo-repo"
+ },
+ "scanned" : "2022-06-14T20:25:00Z",
+ "manifests" : {
+ "package-lock.json" : {
+ "name" : "package-lock.json",
+ "file" : {
+ "source_location" : "src/package-lock.json"
+ },
+ "resolved" : {
+ "@actions/core" : {
+ "package_url" : "pkg:/npm/%40actions/core@1.1.9",
+ "dependencies" : [ "@actions/http-client" ]
+ },
+ "@actions/http-client" : {
+ "package_url" : "pkg:/npm/%40actions/http-client@1.0.7",
+ "dependencies" : [ "tunnel" ]
+ },
+ "tunnel" : {
+ "package_url" : "pkg:/npm/tunnel@0.0.6"
+ }
+ }
+ }
+ }
+}
+
+
+### Get a diff of the dependencies between commits
+## Get a diff of the dependencies between commits
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependency-graph/compare/{{basehead}}
+Accept: application/json
+
+### Export a software bill of materials (SBOM) for a repository.
+## Export a software bill of materials (SBOM) for a repository.
+GET https://api.github.com/repos/{{owner}}/{{repo}}/dependency-graph/sbom
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/EmojisApi.http b/samples/client/github/jetbrains/http/client/Apis/EmojisApi.http
new file mode 100644
index 000000000000..4d983898662c
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/EmojisApi.http
@@ -0,0 +1,6 @@
+## EmojisApi
+
+### Get emojis
+## Get emojis
+GET https://api.github.com/emojis
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/GistsApi.http b/samples/client/github/jetbrains/http/client/Apis/GistsApi.http
new file mode 100644
index 000000000000..218a9496ecad
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/GistsApi.http
@@ -0,0 +1,136 @@
+## GistsApi
+
+### Check if a gist is starred
+## Check if a gist is starred
+GET https://api.github.com/gists/{{gist_id}}/star
+Accept: application/json
+
+### Create a gist
+## Create a gist
+POST https://api.github.com/gists
+Content-Type: application/json
+Accept: application/json
+
+{
+ "description" : "Example of a gist",
+ "public" : false,
+ "files" : {
+ "README.md" : {
+ "content" : "Hello World"
+ }
+ }
+}
+
+
+### Create a gist comment
+## Create a gist comment
+POST https://api.github.com/gists/{{gist_id}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "This is a comment to a gist"
+}
+
+
+### Delete a gist
+## Delete a gist
+DELETE https://api.github.com/gists/{{gist_id}}
+Accept: application/json
+
+### Delete a gist comment
+## Delete a gist comment
+DELETE https://api.github.com/gists/{{gist_id}}/comments/{{comment_id}}
+Accept: application/json
+
+### Fork a gist
+## Fork a gist
+POST https://api.github.com/gists/{{gist_id}}/forks
+Accept: application/json
+
+### Get a gist
+## Get a gist
+GET https://api.github.com/gists/{{gist_id}}
+Accept: application/json
+
+### Get a gist comment
+## Get a gist comment
+GET https://api.github.com/gists/{{gist_id}}/comments/{{comment_id}}
+Accept: application/json
+
+### Get a gist revision
+## Get a gist revision
+GET https://api.github.com/gists/{{gist_id}}/{{sha}}
+Accept: application/json
+
+### List gists for the authenticated user
+## List gists for the authenticated user
+GET https://api.github.com/gists
+Accept: application/json
+
+### List gist comments
+## List gist comments
+GET https://api.github.com/gists/{{gist_id}}/comments
+Accept: application/json
+
+### List gist commits
+## List gist commits
+GET https://api.github.com/gists/{{gist_id}}/commits
+Accept: application/json
+
+### List gists for a user
+## List gists for a user
+GET https://api.github.com/users/{{username}}/gists
+Accept: application/json
+
+### List gist forks
+## List gist forks
+GET https://api.github.com/gists/{{gist_id}}/forks
+Accept: application/json
+
+### List public gists
+## List public gists
+GET https://api.github.com/gists/public
+Accept: application/json
+
+### List starred gists
+## List starred gists
+GET https://api.github.com/gists/starred
+Accept: application/json
+
+### Star a gist
+## Star a gist
+PUT https://api.github.com/gists/{{gist_id}}/star
+Accept: application/json
+
+### Unstar a gist
+## Unstar a gist
+DELETE https://api.github.com/gists/{{gist_id}}/star
+Accept: application/json
+
+### Update a gist
+## Update a gist
+PATCH https://api.github.com/gists/{{gist_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "description" : "An updated gist description",
+ "files" : {
+ "README.md" : {
+ "content" : "Hello World from GitHub"
+ }
+ }
+}
+
+
+### Update a gist comment
+## Update a gist comment
+PATCH https://api.github.com/gists/{{gist_id}}/comments/{{comment_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "This is an update to a comment in a gist"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/GitApi.http b/samples/client/github/jetbrains/http/client/Apis/GitApi.http
new file mode 100644
index 000000000000..49ba7d3cc242
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/GitApi.http
@@ -0,0 +1,127 @@
+## GitApi
+
+### Create a blob
+## Create a blob
+POST https://api.github.com/repos/{{owner}}/{{repo}}/git/blobs
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "Content of the blob",
+ "encoding" : "utf-8"
+}
+
+
+### Create a commit
+## Create a commit
+POST https://api.github.com/repos/{{owner}}/{{repo}}/git/commits
+Content-Type: application/json
+Accept: application/json
+
+{
+ "message" : "my commit message",
+ "author" : {
+ "name" : "Mona Octocat",
+ "email" : "octocat@github.com",
+ "date" : "2008-07-09T16:13:30+12:00"
+ },
+ "parents" : [ "7d1b31e74ee336d15cbd21741bc88a537ed063a0" ],
+ "tree" : "827efc6d56897b048c772eb4087f854f46256132",
+ "signature" : "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
+}
+
+
+### Create a reference
+## Create a reference
+POST https://api.github.com/repos/{{owner}}/{{repo}}/git/refs
+Content-Type: application/json
+Accept: application/json
+
+{
+ "ref" : "refs/heads/featureA",
+ "sha" : "aa218f56b14c9653891f9e74264a383fa43fefbd"
+}
+
+
+### Create a tag object
+## Create a tag object
+POST https://api.github.com/repos/{{owner}}/{{repo}}/git/tags
+Content-Type: application/json
+Accept: application/json
+
+{
+ "tag" : "v0.0.1",
+ "message" : "initial version",
+ "object" : "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type" : "commit",
+ "tagger" : {
+ "name" : "Monalisa Octocat",
+ "email" : "octocat@github.com",
+ "date" : "2011-06-17T14:53:35-07:00"
+ }
+}
+
+
+### Create a tree
+## Create a tree
+POST https://api.github.com/repos/{{owner}}/{{repo}}/git/trees
+Content-Type: application/json
+Accept: application/json
+
+{
+ "base_tree" : "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree" : [ {
+ "path" : "file.rb",
+ "mode" : "100644",
+ "type" : "blob",
+ "sha" : "44b4fc6d56897b048c772eb4087f854f46256132"
+ } ]
+}
+
+
+### Delete a reference
+## Delete a reference
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/git/refs/{{ref}}
+Accept: application/json
+
+### Get a blob
+## Get a blob
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/blobs/{{file_sha}}
+Accept: application/json
+
+### Get a commit object
+## Get a commit object
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/commits/{{commit_sha}}
+Accept: application/json
+
+### Get a reference
+## Get a reference
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/ref/{{ref}}
+Accept: application/json
+
+### Get a tag
+## Get a tag
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/tags/{{tag_sha}}
+Accept: application/json
+
+### Get a tree
+## Get a tree
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/trees/{{tree_sha}}
+Accept: application/json
+
+### List matching references
+## List matching references
+GET https://api.github.com/repos/{{owner}}/{{repo}}/git/matching-refs/{{ref}}
+Accept: application/json
+
+### Update a reference
+## Update a reference
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/git/refs/{{ref}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "sha" : "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force" : true
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/GitignoreApi.http b/samples/client/github/jetbrains/http/client/Apis/GitignoreApi.http
new file mode 100644
index 000000000000..afcd14c646bf
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/GitignoreApi.http
@@ -0,0 +1,11 @@
+## GitignoreApi
+
+### Get all gitignore templates
+## Get all gitignore templates
+GET https://api.github.com/gitignore/templates
+Accept: application/json
+
+### Get a gitignore template
+## Get a gitignore template
+GET https://api.github.com/gitignore/templates/{{name}}
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/InteractionsApi.http b/samples/client/github/jetbrains/http/client/Apis/InteractionsApi.http
new file mode 100644
index 000000000000..df6537abd84c
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/InteractionsApi.http
@@ -0,0 +1,64 @@
+## InteractionsApi
+
+### Get interaction restrictions for your public repositories
+## Get interaction restrictions for your public repositories
+GET https://api.github.com/user/interaction-limits
+Accept: application/json
+
+### Get interaction restrictions for an organization
+## Get interaction restrictions for an organization
+GET https://api.github.com/orgs/{{org}}/interaction-limits
+Accept: application/json
+
+### Get interaction restrictions for a repository
+## Get interaction restrictions for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/interaction-limits
+Accept: application/json
+
+### Remove interaction restrictions from your public repositories
+## Remove interaction restrictions from your public repositories
+DELETE https://api.github.com/user/interaction-limits
+
+### Remove interaction restrictions for an organization
+## Remove interaction restrictions for an organization
+DELETE https://api.github.com/orgs/{{org}}/interaction-limits
+
+### Remove interaction restrictions for a repository
+## Remove interaction restrictions for a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/interaction-limits
+
+### Set interaction restrictions for your public repositories
+## Set interaction restrictions for your public repositories
+PUT https://api.github.com/user/interaction-limits
+Content-Type: application/json
+Accept: application/json
+
+{
+ "limit" : "collaborators_only",
+ "expiry" : "one_month"
+}
+
+
+### Set interaction restrictions for an organization
+## Set interaction restrictions for an organization
+PUT https://api.github.com/orgs/{{org}}/interaction-limits
+Content-Type: application/json
+Accept: application/json
+
+{
+ "limit" : "collaborators_only",
+ "expiry" : "one_month"
+}
+
+
+### Set interaction restrictions for a repository
+## Set interaction restrictions for a repository
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/interaction-limits
+Content-Type: application/json
+Accept: application/json
+
+{
+ "limit" : "collaborators_only",
+ "expiry" : "one_day"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/IssuesApi.http b/samples/client/github/jetbrains/http/client/Apis/IssuesApi.http
new file mode 100644
index 000000000000..ca9584917e99
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/IssuesApi.http
@@ -0,0 +1,297 @@
+## IssuesApi
+
+### Add assignees to an issue
+## Add assignees to an issue
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/assignees
+Content-Type: application/json
+Accept: application/json
+
+{
+ "assignees" : [ "hubot", "other_user" ]
+}
+
+
+### Add labels to an issue
+## Add labels to an issue
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "bug", "enhancement" ]
+}
+
+
+### Check if a user can be assigned
+## Check if a user can be assigned
+GET https://api.github.com/repos/{{owner}}/{{repo}}/assignees/{{assignee}}
+Accept: application/json
+
+### Check if a user can be assigned to a issue
+## Check if a user can be assigned to a issue
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/assignees/{{assignee}}
+Accept: application/json
+
+### Create an issue
+## Create an issue
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "title" : "Found a bug",
+ "body" : "I'm having a problem with this.",
+ "assignees" : [ "octocat" ],
+ "milestone" : 1,
+ "labels" : [ "bug" ]
+}
+
+
+### Create an issue comment
+## Create an issue comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Me too"
+}
+
+
+### Create a label
+## Create a label
+POST https://api.github.com/repos/{{owner}}/{{repo}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "bug",
+ "description" : "Something isn't working",
+ "color" : "f29513"
+}
+
+
+### Create a milestone
+## Create a milestone
+POST https://api.github.com/repos/{{owner}}/{{repo}}/milestones
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "v1.0",
+ "state" : "open",
+ "description" : "Tracking milestone for version 1.0",
+ "due_on" : "2012-10-09T23:39:01Z"
+}
+
+
+### Delete an issue comment
+## Delete an issue comment
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}
+
+### Delete a label
+## Delete a label
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/labels/{{name}}
+
+### Delete a milestone
+## Delete a milestone
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/milestones/{{milestone_number}}
+Accept: application/json
+
+### Get an issue
+## Get an issue
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}
+Accept: application/json
+
+### Get an issue comment
+## Get an issue comment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}
+Accept: application/json
+
+### Get an issue event
+## Get an issue event
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/events/{{event_id}}
+Accept: application/json
+
+### Get a label
+## Get a label
+GET https://api.github.com/repos/{{owner}}/{{repo}}/labels/{{name}}
+Accept: application/json
+
+### Get a milestone
+## Get a milestone
+GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones/{{milestone_number}}
+Accept: application/json
+
+### List issues assigned to the authenticated user
+## List issues assigned to the authenticated user
+GET https://api.github.com/issues
+Accept: application/json
+
+### List assignees
+## List assignees
+GET https://api.github.com/repos/{{owner}}/{{repo}}/assignees
+Accept: application/json
+
+### List issue comments
+## List issue comments
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/comments
+Accept: application/json
+
+### List issue comments for a repository
+## List issue comments for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments
+Accept: application/json
+
+### List issue events
+## List issue events
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/events
+Accept: application/json
+
+### List issue events for a repository
+## List issue events for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/events
+Accept: application/json
+
+### List timeline events for an issue
+## List timeline events for an issue
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/timeline
+Accept: application/json
+
+### List user account issues assigned to the authenticated user
+## List user account issues assigned to the authenticated user
+GET https://api.github.com/user/issues
+Accept: application/json
+
+### List organization issues assigned to the authenticated user
+## List organization issues assigned to the authenticated user
+GET https://api.github.com/orgs/{{org}}/issues
+Accept: application/json
+
+### List repository issues
+## List repository issues
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues
+Accept: application/json
+
+### List labels for issues in a milestone
+## List labels for issues in a milestone
+GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones/{{milestone_number}}/labels
+Accept: application/json
+
+### List labels for a repository
+## List labels for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/labels
+Accept: application/json
+
+### List labels for an issue
+## List labels for an issue
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels
+Accept: application/json
+
+### List milestones
+## List milestones
+GET https://api.github.com/repos/{{owner}}/{{repo}}/milestones
+Accept: application/json
+
+### Lock an issue
+## Lock an issue
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/lock
+Content-Type: application/json
+Accept: application/json
+
+{
+ "lock_reason" : "off-topic"
+}
+
+
+### Remove all labels from an issue
+## Remove all labels from an issue
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels
+Accept: application/json
+
+### Remove assignees from an issue
+## Remove assignees from an issue
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/assignees
+Content-Type: application/json
+Accept: application/json
+
+{
+ "assignees" : [ "hubot", "other_user" ]
+}
+
+
+### Remove a label from an issue
+## Remove a label from an issue
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels/{{name}}
+Accept: application/json
+
+### Set labels for an issue
+## Set labels for an issue
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/labels
+Content-Type: application/json
+Accept: application/json
+
+{
+ "labels" : [ "bug", "enhancement" ]
+}
+
+
+### Unlock an issue
+## Unlock an issue
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/lock
+Accept: application/json
+
+### Update an issue
+## Update an issue
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Found a bug",
+ "body" : "I'm having a problem with this.",
+ "assignees" : [ "octocat" ],
+ "milestone" : 1,
+ "state" : "open",
+ "labels" : [ "bug" ]
+}
+
+
+### Update an issue comment
+## Update an issue comment
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Me too"
+}
+
+
+### Update a label
+## Update a label
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/labels/{{name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "new_name" : "bug :bug:",
+ "description" : "Small bug fix required",
+ "color" : "b01f26"
+}
+
+
+### Update a milestone
+## Update a milestone
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/milestones/{{milestone_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "v1.0",
+ "state" : "open",
+ "description" : "Tracking milestone for version 1.0",
+ "due_on" : "2012-10-09T23:39:01Z"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/LicensesApi.http b/samples/client/github/jetbrains/http/client/Apis/LicensesApi.http
new file mode 100644
index 000000000000..5098f03ae538
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/LicensesApi.http
@@ -0,0 +1,16 @@
+## LicensesApi
+
+### Get a license
+## Get a license
+GET https://api.github.com/licenses/{{license}}
+Accept: application/json
+
+### Get all commonly used licenses
+## Get all commonly used licenses
+GET https://api.github.com/licenses
+Accept: application/json
+
+### Get the license for a repository
+## Get the license for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/license
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/MarkdownApi.http b/samples/client/github/jetbrains/http/client/Apis/MarkdownApi.http
new file mode 100644
index 000000000000..e6334d0a1600
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/MarkdownApi.http
@@ -0,0 +1,24 @@
+## MarkdownApi
+
+### Render a Markdown document
+## Render a Markdown document
+POST https://api.github.com/markdown
+Content-Type: application/json
+Accept: text/html
+
+{
+ "text" : "Hello **world**"
+}
+
+
+### Render a Markdown document in raw mode
+## Render a Markdown document in raw mode
+POST https://api.github.com/markdown/raw
+Content-Type: text/plain
+Content-Type: text/x-markdown
+Accept: text/html
+
+{
+ "text" : "Hello **world**"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/MetaApi.http b/samples/client/github/jetbrains/http/client/Apis/MetaApi.http
new file mode 100644
index 000000000000..966524a21b32
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/MetaApi.http
@@ -0,0 +1,26 @@
+## MetaApi
+
+### Get GitHub meta information
+## Get GitHub meta information
+GET https://api.github.com/meta
+Accept: application/json
+
+### Get all API versions
+## Get all API versions
+GET https://api.github.com/versions
+Accept: application/json
+
+### Get Octocat
+## Get Octocat
+GET https://api.github.com/octocat
+Accept: application/octocat-stream
+
+### Get the Zen of GitHub
+## Get the Zen of GitHub
+GET https://api.github.com/zen
+Accept: application/json
+
+### GitHub API Root
+## GitHub API Root
+GET https://api.github.com/
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/MigrationsApi.http b/samples/client/github/jetbrains/http/client/Apis/MigrationsApi.http
new file mode 100644
index 000000000000..9cb2a9d9aaff
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/MigrationsApi.http
@@ -0,0 +1,154 @@
+## MigrationsApi
+
+### Cancel an import
+## Cancel an import
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/import
+Accept: application/json
+
+### Delete a user migration archive
+## Delete a user migration archive
+DELETE https://api.github.com/user/migrations/{{migration_id}}/archive
+Accept: application/json
+
+### Delete an organization migration archive
+## Delete an organization migration archive
+DELETE https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}/archive
+Accept: application/json
+
+### Download an organization migration archive
+## Download an organization migration archive
+GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}/archive
+Accept: application/json
+
+### Download a user migration archive
+## Download a user migration archive
+GET https://api.github.com/user/migrations/{{migration_id}}/archive
+Accept: application/json
+
+### Get commit authors
+## Get commit authors
+GET https://api.github.com/repos/{{owner}}/{{repo}}/import/authors
+Accept: application/json
+
+### Get an import status
+## Get an import status
+GET https://api.github.com/repos/{{owner}}/{{repo}}/import
+Accept: application/json
+
+### Get large files
+## Get large files
+GET https://api.github.com/repos/{{owner}}/{{repo}}/import/large_files
+Accept: application/json
+
+### Get a user migration status
+## Get a user migration status
+GET https://api.github.com/user/migrations/{{migration_id}}
+Accept: application/json
+
+### Get an organization migration status
+## Get an organization migration status
+GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}
+Accept: application/json
+
+### List user migrations
+## List user migrations
+GET https://api.github.com/user/migrations
+Accept: application/json
+
+### List organization migrations
+## List organization migrations
+GET https://api.github.com/orgs/{{org}}/migrations
+Accept: application/json
+
+### List repositories for a user migration
+## List repositories for a user migration
+GET https://api.github.com/user/migrations/{{migration_id}}/repositories
+Accept: application/json
+
+### List repositories in an organization migration
+## List repositories in an organization migration
+GET https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}/repositories
+Accept: application/json
+
+### Map a commit author
+## Map a commit author
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/import/authors/{{author_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "email" : "hubot@github.com",
+ "name" : "Hubot the Robot"
+}
+
+
+### Update Git LFS preference
+## Update Git LFS preference
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/import/lfs
+Content-Type: application/json
+Accept: application/json
+
+{
+ "use_lfs" : "opt_in"
+}
+
+
+### Start a user migration
+## Start a user migration
+POST https://api.github.com/user/migrations
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repositories" : [ "octocat/Hello-World" ],
+ "lock_repositories" : true
+}
+
+
+### Start an organization migration
+## Start an organization migration
+POST https://api.github.com/orgs/{{org}}/migrations
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repositories" : [ "github/Hello-World" ],
+ "lock_repositories" : true
+}
+
+
+### Start an import
+## Start an import
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/import
+Content-Type: application/json
+Accept: application/json
+
+{
+ "vcs" : "subversion",
+ "vcs_url" : "http://svn.mycompany.com/svn/myproject",
+ "vcs_username" : "octocat",
+ "vcs_password" : "secret"
+}
+
+
+### Unlock a user repository
+## Unlock a user repository
+DELETE https://api.github.com/user/migrations/{{migration_id}}/repos/{{repo_name}}/lock
+Accept: application/json
+
+### Unlock an organization repository
+## Unlock an organization repository
+DELETE https://api.github.com/orgs/{{org}}/migrations/{{migration_id}}/repos/{{repo_name}}/lock
+Accept: application/json
+
+### Update an import
+## Update an import
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/import
+Content-Type: application/json
+Accept: application/json
+
+{
+ "vcs_username" : "octocat",
+ "vcs_password" : "secret"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/OidcApi.http b/samples/client/github/jetbrains/http/client/Apis/OidcApi.http
new file mode 100644
index 000000000000..a84b4d7f4606
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/OidcApi.http
@@ -0,0 +1,17 @@
+## OidcApi
+
+### Get the customization template for an OIDC subject claim for an organization
+## Get the customization template for an OIDC subject claim for an organization
+GET https://api.github.com/orgs/{{org}}/actions/oidc/customization/sub
+Accept: application/json
+
+### Set the customization template for an OIDC subject claim for an organization
+##
+PUT https://api.github.com/orgs/{{org}}/actions/oidc/customization/sub
+Content-Type: application/json
+Accept: application/json
+
+{
+ "include_claim_keys" : [ "repo", "context" ]
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/OrgsApi.http b/samples/client/github/jetbrains/http/client/Apis/OrgsApi.http
new file mode 100644
index 000000000000..255218e5d8e3
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/OrgsApi.http
@@ -0,0 +1,525 @@
+## OrgsApi
+
+### Add a security manager team
+## Add a security manager team
+PUT https://api.github.com/orgs/{{org}}/security-managers/teams/{{team_slug}}
+
+### Assign an organization role to a team
+## Assign an organization role to a team
+PUT https://api.github.com/orgs/{{org}}/organization-roles/teams/{{team_slug}}/{{role_id}}
+
+### Assign an organization role to a user
+## Assign an organization role to a user
+PUT https://api.github.com/orgs/{{org}}/organization-roles/users/{{username}}/{{role_id}}
+
+### Block a user from an organization
+## Block a user from an organization
+PUT https://api.github.com/orgs/{{org}}/blocks/{{username}}
+Accept: application/json
+
+### Cancel an organization invitation
+## Cancel an organization invitation
+DELETE https://api.github.com/orgs/{{org}}/invitations/{{invitation_id}}
+Accept: application/json
+
+### Check if a user is blocked by an organization
+## Check if a user is blocked by an organization
+GET https://api.github.com/orgs/{{org}}/blocks/{{username}}
+Accept: application/json
+
+### Check organization membership for a user
+## Check organization membership for a user
+GET https://api.github.com/orgs/{{org}}/members/{{username}}
+
+### Check public organization membership for a user
+## Check public organization membership for a user
+GET https://api.github.com/orgs/{{org}}/public_members/{{username}}
+
+### Convert an organization member to outside collaborator
+## Convert an organization member to outside collaborator
+PUT https://api.github.com/orgs/{{org}}/outside_collaborators/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "async" : true
+}
+
+
+### Create a custom organization role
+## Create a custom organization role
+POST https://api.github.com/orgs/{{org}}/organization-roles
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Custom Role Manager",
+ "description" : "Permissions to manage custom roles within an org",
+ "permissions" : [ "write_organization_custom_repo_role", "write_organization_custom_org_role", "read_organization_custom_repo_role", "read_organization_custom_org_role" ]
+}
+
+
+### Create an organization invitation
+## Create an organization invitation
+POST https://api.github.com/orgs/{{org}}/invitations
+Content-Type: application/json
+Accept: application/json
+
+{
+ "email" : "octocat@github.com",
+ "role" : "direct_member",
+ "team_ids" : [ 12, 26 ]
+}
+
+
+### Create or update custom properties for an organization
+## Create or update custom properties for an organization
+PATCH https://api.github.com/orgs/{{org}}/properties/schema
+Content-Type: application/json
+Accept: application/json
+
+{
+ "properties" : [ {
+ "property_name" : "environment",
+ "value_type" : "single_select",
+ "required" : true,
+ "default_value" : "production",
+ "description" : "Prod or dev environment",
+ "allowed_values" : [ "production", "development" ],
+ "values_editable_by" : "org_actors"
+ }, {
+ "property_name" : "service",
+ "value_type" : "string"
+ }, {
+ "property_name" : "team",
+ "value_type" : "string",
+ "description" : "Team owning the repository"
+ } ]
+}
+
+
+### Create or update custom property values for organization repositories
+##
+PATCH https://api.github.com/orgs/{{org}}/properties/values
+Content-Type: application/json
+Accept: application/json
+
+{
+ "repository_names" : [ "Hello-World", "octo-repo" ],
+ "properties" : [ {
+ "property_name" : "environment",
+ "value" : "production"
+ }, {
+ "property_name" : "service",
+ "value" : "web"
+ }, {
+ "property_name" : "team",
+ "value" : "octocat"
+ } ]
+}
+
+
+### Create or update a custom property for an organization
+## Create or update a custom property for an organization
+PUT https://api.github.com/orgs/{{org}}/properties/schema/{{custom_property_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "value_type" : "single_select",
+ "required" : true,
+ "default_value" : "production",
+ "description" : "Prod or dev environment",
+ "allowed_values" : [ "production", "development" ]
+}
+
+
+### Create an organization webhook
+## Create an organization webhook
+POST https://api.github.com/orgs/{{org}}/hooks
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "web",
+ "active" : true,
+ "events" : [ "push", "pull_request" ],
+ "config" : {
+ "url" : "http://example.com/webhook",
+ "content_type" : "json"
+ }
+}
+
+
+### Delete an organization
+## Delete an organization
+DELETE https://api.github.com/orgs/{{org}}
+Accept: application/json
+
+### Delete a custom organization role.
+## Delete a custom organization role.
+DELETE https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}
+
+### Delete an organization webhook
+## Delete an organization webhook
+DELETE https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}
+Accept: application/json
+
+
+### Get an organization
+## Get an organization
+GET https://api.github.com/orgs/{{org}}
+Accept: application/json
+
+### Get all custom properties for an organization
+## Get all custom properties for an organization
+GET https://api.github.com/orgs/{{org}}/properties/schema
+Accept: application/json
+
+### Get a custom property for an organization
+## Get a custom property for an organization
+GET https://api.github.com/orgs/{{org}}/properties/schema/{{custom_property_name}}
+Accept: application/json
+
+### Get an organization membership for the authenticated user
+## Get an organization membership for the authenticated user
+GET https://api.github.com/user/memberships/orgs/{{org}}
+Accept: application/json
+
+### Get organization membership for a user
+## Get organization membership for a user
+GET https://api.github.com/orgs/{{org}}/memberships/{{username}}
+Accept: application/json
+
+### Get an organization role
+## Get an organization role
+GET https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}
+Accept: application/json
+
+### Get an organization webhook
+## Get an organization webhook
+GET https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}
+Accept: application/json
+
+### Get a webhook configuration for an organization
+## Get a webhook configuration for an organization
+GET https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/config
+Accept: application/json
+
+### Get a webhook delivery for an organization webhook
+## Get a webhook delivery for an organization webhook
+GET https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/deliveries/{{delivery_id}}
+Accept: application/json
+Accept: application/scim+json
+
+### List organizations
+## List organizations
+GET https://api.github.com/organizations
+Accept: application/json
+
+### List app installations for an organization
+## List app installations for an organization
+GET https://api.github.com/orgs/{{org}}/installations
+Accept: application/json
+
+### List users blocked by an organization
+## List users blocked by an organization
+GET https://api.github.com/orgs/{{org}}/blocks
+Accept: application/json
+
+### List custom property values for organization repositories
+## List custom property values for organization repositories
+GET https://api.github.com/orgs/{{org}}/properties/values
+Accept: application/json
+
+### List failed organization invitations
+## List failed organization invitations
+GET https://api.github.com/orgs/{{org}}/failed_invitations
+Accept: application/json
+
+### List organizations for the authenticated user
+## List organizations for the authenticated user
+GET https://api.github.com/user/orgs
+Accept: application/json
+
+### List organizations for a user
+## List organizations for a user
+GET https://api.github.com/users/{{username}}/orgs
+Accept: application/json
+
+### List organization invitation teams
+## List organization invitation teams
+GET https://api.github.com/orgs/{{org}}/invitations/{{invitation_id}}/teams
+Accept: application/json
+
+### List organization members
+## List organization members
+GET https://api.github.com/orgs/{{org}}/members
+Accept: application/json
+
+### List organization memberships for the authenticated user
+## List organization memberships for the authenticated user
+GET https://api.github.com/user/memberships/orgs
+Accept: application/json
+
+### List teams that are assigned to an organization role
+## List teams that are assigned to an organization role
+GET https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}/teams
+Accept: application/json
+
+### List users that are assigned to an organization role
+## List users that are assigned to an organization role
+GET https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}/users
+Accept: application/json
+
+### Get all organization roles for an organization
+## Get all organization roles for an organization
+GET https://api.github.com/orgs/{{org}}/organization-roles
+Accept: application/json
+
+### List organization fine-grained permissions for an organization
+## List organization fine-grained permissions for an organization
+GET https://api.github.com/orgs/{{org}}/organization-fine-grained-permissions
+Accept: application/json
+
+### List outside collaborators for an organization
+## List outside collaborators for an organization
+GET https://api.github.com/orgs/{{org}}/outside_collaborators
+Accept: application/json
+
+### List repositories a fine-grained personal access token has access to
+## List repositories a fine-grained personal access token has access to
+GET https://api.github.com/orgs/{{org}}/personal-access-tokens/{{pat_id}}/repositories
+Accept: application/json
+
+### List repositories requested to be accessed by a fine-grained personal access token
+## List repositories requested to be accessed by a fine-grained personal access token
+GET https://api.github.com/orgs/{{org}}/personal-access-token-requests/{{pat_request_id}}/repositories
+Accept: application/json
+
+### List requests to access organization resources with fine-grained personal access tokens
+## List requests to access organization resources with fine-grained personal access tokens
+GET https://api.github.com/orgs/{{org}}/personal-access-token-requests
+Accept: application/json
+
+### List fine-grained personal access tokens with access to organization resources
+## List fine-grained personal access tokens with access to organization resources
+GET https://api.github.com/orgs/{{org}}/personal-access-tokens
+Accept: application/json
+
+### List pending organization invitations
+## List pending organization invitations
+GET https://api.github.com/orgs/{{org}}/invitations
+Accept: application/json
+
+### List public organization members
+## List public organization members
+GET https://api.github.com/orgs/{{org}}/public_members
+Accept: application/json
+
+### List security manager teams
+## List security manager teams
+GET https://api.github.com/orgs/{{org}}/security-managers
+Accept: application/json
+
+### List deliveries for an organization webhook
+## List deliveries for an organization webhook
+GET https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/deliveries
+Accept: application/json
+Accept: application/scim+json
+
+### List organization webhooks
+## List organization webhooks
+GET https://api.github.com/orgs/{{org}}/hooks
+Accept: application/json
+
+### Update a custom organization role
+## Update a custom organization role
+PATCH https://api.github.com/orgs/{{org}}/organization-roles/{{role_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "description" : "Permissions to manage custom roles within an org."
+}
+
+
+### Ping an organization webhook
+## Ping an organization webhook
+POST https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/pings
+Accept: application/json
+
+### Redeliver a delivery for an organization webhook
+## Redeliver a delivery for an organization webhook
+POST https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/deliveries/{{delivery_id}}/attempts
+Accept: application/json
+Accept: application/scim+json
+
+### Remove a custom property for an organization
+## Remove a custom property for an organization
+DELETE https://api.github.com/orgs/{{org}}/properties/schema/{{custom_property_name}}
+Accept: application/json
+
+### Remove an organization member
+## Remove an organization member
+DELETE https://api.github.com/orgs/{{org}}/members/{{username}}
+Accept: application/json
+
+### Remove organization membership for a user
+## Remove organization membership for a user
+DELETE https://api.github.com/orgs/{{org}}/memberships/{{username}}
+Accept: application/json
+
+### Remove outside collaborator from an organization
+## Remove outside collaborator from an organization
+DELETE https://api.github.com/orgs/{{org}}/outside_collaborators/{{username}}
+Accept: application/json
+
+### Remove public organization membership for the authenticated user
+## Remove public organization membership for the authenticated user
+DELETE https://api.github.com/orgs/{{org}}/public_members/{{username}}
+
+### Remove a security manager team
+## Remove a security manager team
+DELETE https://api.github.com/orgs/{{org}}/security-managers/teams/{{team_slug}}
+
+### Review a request to access organization resources with a fine-grained personal access token
+## Review a request to access organization resources with a fine-grained personal access token
+POST https://api.github.com/orgs/{{org}}/personal-access-token-requests/{{pat_request_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "action" : "deny",
+ "reason" : "This request is denied because the access is too broad."
+}
+
+
+### Review requests to access organization resources with fine-grained personal access tokens
+## Review requests to access organization resources with fine-grained personal access tokens
+POST https://api.github.com/orgs/{{org}}/personal-access-token-requests
+Content-Type: application/json
+Accept: application/json
+
+{
+ "pat_request_ids" : [ 42, 73 ],
+ "action" : "deny",
+ "reason" : "Access is too broad."
+}
+
+
+### Remove all organization roles for a team
+## Remove all organization roles for a team
+DELETE https://api.github.com/orgs/{{org}}/organization-roles/teams/{{team_slug}}
+
+### Remove all organization roles for a user
+## Remove all organization roles for a user
+DELETE https://api.github.com/orgs/{{org}}/organization-roles/users/{{username}}
+
+### Remove an organization role from a team
+## Remove an organization role from a team
+DELETE https://api.github.com/orgs/{{org}}/organization-roles/teams/{{team_slug}}/{{role_id}}
+
+### Remove an organization role from a user
+## Remove an organization role from a user
+DELETE https://api.github.com/orgs/{{org}}/organization-roles/users/{{username}}/{{role_id}}
+
+### Set organization membership for a user
+## Set organization membership for a user
+PUT https://api.github.com/orgs/{{org}}/memberships/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "role" : "member"
+}
+
+
+### Set public organization membership for the authenticated user
+## Set public organization membership for the authenticated user
+PUT https://api.github.com/orgs/{{org}}/public_members/{{username}}
+Accept: application/json
+
+### Unblock a user from an organization
+## Unblock a user from an organization
+DELETE https://api.github.com/orgs/{{org}}/blocks/{{username}}
+
+### Update an organization
+## Update an organization
+PATCH https://api.github.com/orgs/{{org}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "billing_email" : "mona@github.com",
+ "company" : "GitHub",
+ "email" : "mona@github.com",
+ "twitter_username" : "github",
+ "location" : "San Francisco",
+ "name" : "github",
+ "description" : "GitHub, the company.",
+ "default_repository_permission" : "read",
+ "members_can_create_repositories" : true,
+ "members_allowed_repository_creation_type" : "all"
+}
+
+
+### Update an organization membership for the authenticated user
+## Update an organization membership for the authenticated user
+PATCH https://api.github.com/user/memberships/orgs/{{org}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "state" : "active"
+}
+
+
+### Update the access a fine-grained personal access token has to organization resources
+## Update the access a fine-grained personal access token has to organization resources
+POST https://api.github.com/orgs/{{org}}/personal-access-tokens/{{pat_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "action" : "revoke"
+}
+
+
+### Update the access to organization resources via fine-grained personal access tokens
+## Update the access to organization resources via fine-grained personal access tokens
+POST https://api.github.com/orgs/{{org}}/personal-access-tokens
+Content-Type: application/json
+Accept: application/json
+
+{
+ "action" : "revoke",
+ "pat_ids" : [ 1296269, 1296280 ]
+}
+
+
+### Update an organization webhook
+## Update an organization webhook
+PATCH https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "active" : true,
+ "events" : [ "pull_request" ]
+}
+
+
+### Update a webhook configuration for an organization
+## Update a webhook configuration for an organization
+PATCH https://api.github.com/orgs/{{org}}/hooks/{{hook_id}}/config
+Content-Type: application/json
+Accept: application/json
+
+{
+ "url" : "http://example.com/webhook",
+ "content_type" : "json",
+ "insecure_ssl" : "0",
+ "secret" : "********"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/PackagesApi.http b/samples/client/github/jetbrains/http/client/Apis/PackagesApi.http
new file mode 100644
index 000000000000..3721beb039cc
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/PackagesApi.http
@@ -0,0 +1,136 @@
+## PackagesApi
+
+### Delete a package for the authenticated user
+## Delete a package for the authenticated user
+DELETE https://api.github.com/user/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Delete a package for an organization
+## Delete a package for an organization
+DELETE https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Delete a package for a user
+## Delete a package for a user
+DELETE https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Delete a package version for the authenticated user
+## Delete a package version for the authenticated user
+DELETE https://api.github.com/user/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### Delete package version for an organization
+## Delete package version for an organization
+DELETE https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### Delete package version for a user
+## Delete package version for a user
+DELETE https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### List package versions for a package owned by the authenticated user
+## List package versions for a package owned by the authenticated user
+GET https://api.github.com/user/packages/{{package_type}}/{{package_name}}/versions
+Accept: application/json
+
+### List package versions for a package owned by an organization
+## List package versions for a package owned by an organization
+GET https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/versions
+Accept: application/json
+
+### List package versions for a package owned by a user
+## List package versions for a package owned by a user
+GET https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/versions
+Accept: application/json
+
+### Get a package for the authenticated user
+## Get a package for the authenticated user
+GET https://api.github.com/user/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Get a package for an organization
+## Get a package for an organization
+GET https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Get a package for a user
+## Get a package for a user
+GET https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}
+Accept: application/json
+
+### Get a package version for the authenticated user
+## Get a package version for the authenticated user
+GET https://api.github.com/user/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### Get a package version for an organization
+## Get a package version for an organization
+GET https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### Get a package version for a user
+## Get a package version for a user
+GET https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}
+Accept: application/json
+
+### Get list of conflicting packages during Docker migration for authenticated-user
+## Get list of conflicting packages during Docker migration for authenticated-user
+GET https://api.github.com/user/docker/conflicts
+Accept: application/json
+
+### Get list of conflicting packages during Docker migration for organization
+## Get list of conflicting packages during Docker migration for organization
+GET https://api.github.com/orgs/{{org}}/docker/conflicts
+Accept: application/json
+
+### Get list of conflicting packages during Docker migration for user
+## Get list of conflicting packages during Docker migration for user
+GET https://api.github.com/users/{{username}}/docker/conflicts
+Accept: application/json
+
+### List packages for the authenticated user's namespace
+## List packages for the authenticated user's namespace
+GET https://api.github.com/user/packages
+Accept: application/json
+
+### List packages for an organization
+## List packages for an organization
+GET https://api.github.com/orgs/{{org}}/packages
+Accept: application/json
+
+### List packages for a user
+## List packages for a user
+GET https://api.github.com/users/{{username}}/packages
+Accept: application/json
+
+### Restore a package for the authenticated user
+## Restore a package for the authenticated user
+POST https://api.github.com/user/packages/{{package_type}}/{{package_name}}/restore
+Accept: application/json
+
+### Restore a package for an organization
+## Restore a package for an organization
+POST https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/restore
+Accept: application/json
+
+### Restore a package for a user
+## Restore a package for a user
+POST https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/restore
+Accept: application/json
+
+### Restore a package version for the authenticated user
+## Restore a package version for the authenticated user
+POST https://api.github.com/user/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}/restore
+Accept: application/json
+
+### Restore package version for an organization
+## Restore package version for an organization
+POST https://api.github.com/orgs/{{org}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}/restore
+Accept: application/json
+
+### Restore package version for a user
+## Restore package version for a user
+POST https://api.github.com/users/{{username}}/packages/{{package_type}}/{{package_name}}/versions/{{package_version_id}}/restore
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/ProjectsApi.http b/samples/client/github/jetbrains/http/client/Apis/ProjectsApi.http
new file mode 100644
index 000000000000..b7c6cd111ea1
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ProjectsApi.http
@@ -0,0 +1,198 @@
+## ProjectsApi
+
+### Add project collaborator
+## Add project collaborator
+PUT https://api.github.com/projects/{{project_id}}/collaborators/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permission" : "write"
+}
+
+
+### Create a project card
+## Create a project card
+POST https://api.github.com/projects/columns/{{column_id}}/cards
+Content-Type: application/json
+Accept: application/json
+
+{
+ "note" : "Add payload for delete Project column"
+}
+
+
+### Create a project column
+## Create a project column
+POST https://api.github.com/projects/{{project_id}}/columns
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Remaining tasks"
+}
+
+
+### Create a user project
+## Create a user project
+POST https://api.github.com/user/projects
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "My Projects",
+ "body" : "A board to manage my personal projects."
+}
+
+
+### Create an organization project
+## Create an organization project
+POST https://api.github.com/orgs/{{org}}/projects
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Organization Roadmap",
+ "body" : "High-level roadmap for the upcoming year."
+}
+
+
+### Create a repository project
+## Create a repository project
+POST https://api.github.com/repos/{{owner}}/{{repo}}/projects
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Projects Documentation",
+ "body" : "Developer documentation project for the developer site."
+}
+
+
+### Delete a project
+## Delete a project
+DELETE https://api.github.com/projects/{{project_id}}
+Accept: application/json
+
+### Delete a project card
+## Delete a project card
+DELETE https://api.github.com/projects/columns/cards/{{card_id}}
+Accept: application/json
+
+### Delete a project column
+## Delete a project column
+DELETE https://api.github.com/projects/columns/{{column_id}}
+Accept: application/json
+
+### Get a project
+## Get a project
+GET https://api.github.com/projects/{{project_id}}
+Accept: application/json
+
+### Get a project card
+## Get a project card
+GET https://api.github.com/projects/columns/cards/{{card_id}}
+Accept: application/json
+
+### Get a project column
+## Get a project column
+GET https://api.github.com/projects/columns/{{column_id}}
+Accept: application/json
+
+### Get project permission for a user
+## Get project permission for a user
+GET https://api.github.com/projects/{{project_id}}/collaborators/{{username}}/permission
+Accept: application/json
+
+### List project cards
+## List project cards
+GET https://api.github.com/projects/columns/{{column_id}}/cards
+Accept: application/json
+
+### List project collaborators
+## List project collaborators
+GET https://api.github.com/projects/{{project_id}}/collaborators
+Accept: application/json
+
+### List project columns
+## List project columns
+GET https://api.github.com/projects/{{project_id}}/columns
+Accept: application/json
+
+### List organization projects
+## List organization projects
+GET https://api.github.com/orgs/{{org}}/projects
+Accept: application/json
+
+### List repository projects
+## List repository projects
+GET https://api.github.com/repos/{{owner}}/{{repo}}/projects
+Accept: application/json
+
+### List user projects
+## List user projects
+GET https://api.github.com/users/{{username}}/projects
+Accept: application/json
+
+### Move a project card
+## Move a project card
+POST https://api.github.com/projects/columns/cards/{{card_id}}/moves
+Content-Type: application/json
+Accept: application/json
+
+{
+ "column_id" : 42,
+ "position" : "bottom"
+}
+
+
+### Move a project column
+## Move a project column
+POST https://api.github.com/projects/columns/{{column_id}}/moves
+Content-Type: application/json
+Accept: application/json
+
+{
+ "position" : "last"
+}
+
+
+### Remove user as a collaborator
+## Remove user as a collaborator
+DELETE https://api.github.com/projects/{{project_id}}/collaborators/{{username}}
+Accept: application/json
+
+### Update a project
+## Update a project
+PATCH https://api.github.com/projects/{{project_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Week One Sprint",
+ "state" : "open",
+ "organization_permission" : "write"
+}
+
+
+### Update an existing project card
+## Update an existing project card
+PATCH https://api.github.com/projects/columns/cards/{{card_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "note" : "Add payload for delete Project column"
+}
+
+
+### Update an existing project column
+## Update an existing project column
+PATCH https://api.github.com/projects/columns/{{column_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "To Do"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/PullsApi.http b/samples/client/github/jetbrains/http/client/Apis/PullsApi.http
new file mode 100644
index 000000000000..34466eceb3d1
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/PullsApi.http
@@ -0,0 +1,237 @@
+## PullsApi
+
+### Check if a pull request has been merged
+## Check if a pull request has been merged
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/merge
+
+### Create a pull request
+## Create a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Amazing new feature",
+ "body" : "Please pull these awesome changes in!",
+ "head" : "octocat:new-feature",
+ "base" : "master"
+}
+
+
+### Create a reply for a review comment
+## Create a reply for a review comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/comments/{{comment_id}}/replies
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Great stuff!"
+}
+
+
+### Create a review for a pull request
+## Create a review for a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews
+Content-Type: application/json
+Accept: application/json
+
+{
+ "commit_id" : "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body" : "This is close to perfect! Please address the suggested inline change.",
+ "event" : "REQUEST_CHANGES",
+ "comments" : [ {
+ "path" : "file.md",
+ "position" : 6,
+ "body" : "Please add more information here, and fix this typo."
+ } ]
+}
+
+
+### Create a review comment for a pull request
+## Create a review comment for a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Great stuff!",
+ "commit_id" : "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "path" : "file1.txt",
+ "start_line" : 1,
+ "start_side" : "RIGHT",
+ "line" : 2,
+ "side" : "RIGHT"
+}
+
+
+### Delete a pending review for a pull request
+## Delete a pending review for a pull request
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}
+Accept: application/json
+
+### Delete a review comment for a pull request
+## Delete a review comment for a pull request
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}
+Accept: application/json
+
+### Dismiss a review for a pull request
+## Dismiss a review for a pull request
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}/dismissals
+Content-Type: application/json
+Accept: application/json
+
+{
+ "message" : "You are dismissed",
+ "event" : "DISMISS"
+}
+
+
+### Get a pull request
+## Get a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}
+Accept: application/json
+
+### Get a review for a pull request
+## Get a review for a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}
+Accept: application/json
+
+### Get a review comment for a pull request
+## Get a review comment for a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}
+Accept: application/json
+
+### List pull requests
+## List pull requests
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls
+Accept: application/json
+
+### List comments for a pull request review
+## List comments for a pull request review
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}/comments
+Accept: application/json
+
+### List commits on a pull request
+## List commits on a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/commits
+Accept: application/json
+
+### List pull requests files
+## List pull requests files
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/files
+Accept: application/json
+
+### Get all requested reviewers for a pull request
+## Get all requested reviewers for a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/requested_reviewers
+Accept: application/json
+
+### List review comments on a pull request
+## List review comments on a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/comments
+Accept: application/json
+
+### List review comments in a repository
+## List review comments in a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments
+Accept: application/json
+
+### List reviews for a pull request
+## List reviews for a pull request
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews
+Accept: application/json
+
+### Merge a pull request
+## Merge a pull request
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/merge
+Content-Type: application/json
+Accept: application/json
+
+{
+ "commit_title" : "Expand enum",
+ "commit_message" : "Add a new value to the merge_method enum"
+}
+
+
+### Remove requested reviewers from a pull request
+## Remove requested reviewers from a pull request
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/requested_reviewers
+Content-Type: application/json
+Accept: application/json
+
+{
+ "reviewers" : [ "octocat", "hubot", "other_user" ],
+ "team_reviewers" : [ "justice-league" ]
+}
+
+
+### Request reviewers for a pull request
+## Request reviewers for a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/requested_reviewers
+Content-Type: application/json
+Accept: application/json
+
+{
+ "reviewers" : [ "octocat", "hubot", "other_user" ],
+ "team_reviewers" : [ "justice-league" ]
+}
+
+
+### Submit a review for a pull request
+## Submit a review for a pull request
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}/events
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Here is the body for the review.",
+ "event" : "REQUEST_CHANGES"
+}
+
+
+### Update a pull request
+## Update a pull request
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "new title",
+ "body" : "updated body",
+ "state" : "open",
+ "base" : "master"
+}
+
+
+### Update a pull request branch
+## Update a pull request branch
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/update-branch
+Content-Type: application/json
+Accept: application/json
+
+{
+ "expected_head_sha" : "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+}
+
+
+### Update a review for a pull request
+## Update a review for a pull request
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/reviews/{{review_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "This is close to perfect! Please address the suggested inline change. And add more about this."
+}
+
+
+### Update a review comment for a pull request
+## Update a review comment for a pull request
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "I like this too!"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/RateLimitApi.http b/samples/client/github/jetbrains/http/client/Apis/RateLimitApi.http
new file mode 100644
index 000000000000..d72d91ee94f7
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/RateLimitApi.http
@@ -0,0 +1,6 @@
+## RateLimitApi
+
+### Get rate limit status for the authenticated user
+## Get rate limit status for the authenticated user
+GET https://api.github.com/rate_limit
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/ReactionsApi.http b/samples/client/github/jetbrains/http/client/Apis/ReactionsApi.http
new file mode 100644
index 000000000000..05fbddca52ae
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ReactionsApi.http
@@ -0,0 +1,173 @@
+## ReactionsApi
+
+### Create reaction for a commit comment
+## Create reaction for a commit comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for an issue
+## Create reaction for an issue
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for an issue comment
+## Create reaction for an issue comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a pull request review comment
+## Create reaction for a pull request review comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a release
+## Create reaction for a release
+POST https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a team discussion comment
+## Create reaction for a team discussion comment
+POST https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a team discussion comment (Legacy)
+## Create reaction for a team discussion comment (Legacy)
+POST https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a team discussion
+## Create reaction for a team discussion
+POST https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Create reaction for a team discussion (Legacy)
+## Create reaction for a team discussion (Legacy)
+POST https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/reactions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content" : "heart"
+}
+
+
+### Delete a commit comment reaction
+## Delete a commit comment reaction
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}/reactions/{{reaction_id}}
+
+### Delete an issue reaction
+## Delete an issue reaction
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/reactions/{{reaction_id}}
+
+### Delete an issue comment reaction
+## Delete an issue comment reaction
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}/reactions/{{reaction_id}}
+
+### Delete a pull request comment reaction
+## Delete a pull request comment reaction
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}/reactions/{{reaction_id}}
+
+### Delete a release reaction
+## Delete a release reaction
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/reactions/{{reaction_id}}
+
+### Delete team discussion reaction
+## Delete team discussion reaction
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/reactions/{{reaction_id}}
+
+### Delete team discussion comment reaction
+## Delete team discussion comment reaction
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions/{{reaction_id}}
+
+### List reactions for a commit comment
+## List reactions for a commit comment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}/reactions
+Accept: application/json
+
+### List reactions for an issue
+## List reactions for an issue
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/{{issue_number}}/reactions
+Accept: application/json
+
+### List reactions for an issue comment
+## List reactions for an issue comment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/issues/comments/{{comment_id}}/reactions
+Accept: application/json
+
+### List reactions for a pull request review comment
+## List reactions for a pull request review comment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pulls/comments/{{comment_id}}/reactions
+Accept: application/json
+
+### List reactions for a release
+## List reactions for a release
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/reactions
+Accept: application/json
+
+### List reactions for a team discussion comment
+## List reactions for a team discussion comment
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions
+Accept: application/json
+
+### List reactions for a team discussion comment (Legacy)
+## List reactions for a team discussion comment (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}/reactions
+Accept: application/json
+
+### List reactions for a team discussion
+## List reactions for a team discussion
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/reactions
+Accept: application/json
+
+### List reactions for a team discussion (Legacy)
+## List reactions for a team discussion (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/reactions
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/ReposApi.http b/samples/client/github/jetbrains/http/client/Apis/ReposApi.http
new file mode 100644
index 000000000000..958800c1d2af
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/ReposApi.http
@@ -0,0 +1,1567 @@
+## ReposApi
+
+### Accept a repository invitation
+## Accept a repository invitation
+PATCH https://api.github.com/user/repository_invitations/{{invitation_id}}
+Accept: application/json
+
+### Add app access restrictions
+## Add app access restrictions
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/apps
+Content-Type: application/json
+Accept: application/json
+
+{
+ "apps" : [ "octoapp" ]
+}
+
+
+### Add a repository collaborator
+## Add a repository collaborator
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/collaborators/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permission" : "triage"
+}
+
+
+### Add status check contexts
+## Add status check contexts
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks/contexts
+Content-Type: application/json
+Accept: application/json
+
+{
+ "contexts" : [ "continuous-integration/travis-ci", "continuous-integration/jenkins" ]
+}
+
+
+### Add team access restrictions
+## Add team access restrictions
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "teams" : [ "justice-league" ]
+}
+
+
+### Add user access restrictions
+## Add user access restrictions
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "users" : [ "octocat" ]
+}
+
+
+### Cancel a GitHub Pages deployment
+## Cancel a GitHub Pages deployment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pages/deployments/{{pages_deployment_id}}/cancel
+Accept: application/json
+
+### Check if automated security fixes are enabled for a repository
+## Check if automated security fixes are enabled for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/automated-security-fixes
+Accept: application/json
+
+### Check if a user is a repository collaborator
+## Check if a user is a repository collaborator
+GET https://api.github.com/repos/{{owner}}/{{repo}}/collaborators/{{username}}
+
+### Check if vulnerability alerts are enabled for a repository
+## Check if vulnerability alerts are enabled for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/vulnerability-alerts
+
+### List CODEOWNERS errors
+## List CODEOWNERS errors
+GET https://api.github.com/repos/{{owner}}/{{repo}}/codeowners/errors
+Accept: application/json
+
+### Compare two commits
+## Compare two commits
+GET https://api.github.com/repos/{{owner}}/{{repo}}/compare/{{basehead}}
+Accept: application/json
+
+### Create an autolink reference for a repository
+## Create an autolink reference for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/autolinks
+Content-Type: application/json
+Accept: application/json
+
+{
+ "key_prefix" : "TICKET-",
+ "url_template" : "https://example.com/TICKET?query=",
+ "is_alphanumeric" : true
+}
+
+
+### Create a commit comment
+## Create a commit comment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Great stuff",
+ "path" : "file1.txt",
+ "position" : 4,
+ "line" : 1
+}
+
+
+### Create commit signature protection
+## Create commit signature protection
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_signatures
+Accept: application/json
+
+### Create a commit status
+## Create a commit status
+POST https://api.github.com/repos/{{owner}}/{{repo}}/statuses/{{sha}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "state" : "success",
+ "target_url" : "https://example.com/build/status",
+ "description" : "The build succeeded!",
+ "context" : "continuous-integration/jenkins"
+}
+
+
+### Create a deploy key
+## Create a deploy key
+POST https://api.github.com/repos/{{owner}}/{{repo}}/keys
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "octocat@octomac",
+ "key" : "ssh-rsa AAA...",
+ "read_only" : true
+}
+
+
+### Create a deployment
+## Create a deployment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/deployments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "ref" : "topic-branch",
+ "payload" : "{ \"deploy\": \"migrate\" }",
+ "description" : "Deploy request from hubot"
+}
+
+
+### Create a deployment branch policy
+## Create a deployment branch policy
+POST https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "release/*"
+}
+
+
+### Create a custom deployment protection rule on an environment
+## Create a custom deployment protection rule on an environment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules
+Content-Type: application/json
+Accept: application/json
+
+{
+ "integration_id" : 5
+}
+
+
+### Create a deployment status
+## Create a deployment status
+POST https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}/statuses
+Content-Type: application/json
+Accept: application/json
+
+{
+ "environment" : "production",
+ "state" : "success",
+ "log_url" : "https://example.com/deployment/42/output",
+ "description" : "Deployment finished successfully."
+}
+
+
+### Create a repository dispatch event
+## Create a repository dispatch event
+POST https://api.github.com/repos/{{owner}}/{{repo}}/dispatches
+Content-Type: application/json
+Accept: application/json
+
+{
+ "event_type" : "on-demand-test",
+ "client_payload" : {
+ "unit" : false,
+ "integration" : true
+ }
+}
+
+
+### Create a repository for the authenticated user
+## Create a repository for the authenticated user
+POST https://api.github.com/user/repos
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "name" : "Hello-World",
+ "description" : "This is your first repo!",
+ "homepage" : "https://github.com",
+ "private" : false,
+ "is_template" : true
+}
+
+
+### Create a fork
+## Create a fork
+POST https://api.github.com/repos/{{owner}}/{{repo}}/forks
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "organization" : "octocat",
+ "name" : "Hello-World",
+ "default_branch_only" : true
+}
+
+
+### Create an organization repository
+## Create an organization repository
+POST https://api.github.com/orgs/{{org}}/repos
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Hello-World",
+ "description" : "This is your first repository",
+ "homepage" : "https://github.com",
+ "private" : false,
+ "has_issues" : true,
+ "has_projects" : true,
+ "has_wiki" : true
+}
+
+
+### Create or update custom property values for a repository
+##
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/properties/values
+Content-Type: application/json
+Accept: application/json
+
+{
+ "properties" : [ {
+ "property_name" : "environment",
+ "value" : "production"
+ }, {
+ "property_name" : "service",
+ "value" : "web"
+ }, {
+ "property_name" : "team",
+ "value" : "octocat"
+ } ]
+}
+
+
+### Create or update an environment
+## Create or update an environment
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "wait_timer" : 30,
+ "prevent_self_review" : false,
+ "reviewers" : [ {
+ "type" : "User",
+ "id" : 1
+ }, {
+ "type" : "Team",
+ "id" : 1
+ } ],
+ "deployment_branch_policy" : {
+ "protected_branches" : false,
+ "custom_branch_policies" : true
+ }
+}
+
+
+### Create or update file contents
+## Create or update file contents
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/contents/{{path}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "message" : "my commit message",
+ "committer" : {
+ "name" : "Monalisa Octocat",
+ "email" : "octocat@github.com"
+ },
+ "content" : "bXkgbmV3IGZpbGUgY29udGVudHM="
+}
+
+
+### Create an organization repository ruleset
+## Create an organization repository ruleset
+POST https://api.github.com/orgs/{{org}}/rulesets
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "super cool ruleset",
+ "target" : "branch",
+ "enforcement" : "active",
+ "bypass_actors" : [ {
+ "actor_id" : 234,
+ "actor_type" : "Team",
+ "bypass_mode" : "always"
+ } ],
+ "conditions" : {
+ "ref_name" : {
+ "include" : [ "refs/heads/main", "refs/heads/master" ],
+ "exclude" : [ "refs/heads/dev*" ]
+ },
+ "repository_name" : {
+ "include" : [ "important_repository", "another_important_repository" ],
+ "exclude" : [ "unimportant_repository" ],
+ "protected" : true
+ }
+ },
+ "rules" : [ {
+ "type" : "commit_author_email_pattern",
+ "parameters" : {
+ "operator" : "contains",
+ "pattern" : "github"
+ }
+ } ]
+}
+
+
+### Create a GitHub Pages deployment
+## Create a GitHub Pages deployment
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pages/deployments
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "artifact_url" : "https://downloadcontent/",
+ "environment" : "github-pages",
+ "pages_build_version" : "4fd754f7e594640989b406850d0bc8f06a121251",
+ "oidc_token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA",
+ "preview" : false
+}
+
+
+### Create a GitHub Pages site
+## Create a GitHub Pages site
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pages
+Content-Type: application/json
+Accept: application/json
+
+{
+ "source" : {
+ "branch" : "main",
+ "path" : "/docs"
+ }
+}
+
+
+### Create a release
+## Create a release
+POST https://api.github.com/repos/{{owner}}/{{repo}}/releases
+Content-Type: application/json
+Accept: application/json
+
+{
+ "tag_name" : "v1.0.0",
+ "target_commitish" : "master",
+ "name" : "v1.0.0",
+ "body" : "Description of the release",
+ "draft" : false,
+ "prerelease" : false,
+ "generate_release_notes" : false
+}
+
+
+### Create a repository ruleset
+## Create a repository ruleset
+POST https://api.github.com/repos/{{owner}}/{{repo}}/rulesets
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "super cool ruleset",
+ "target" : "branch",
+ "enforcement" : "active",
+ "bypass_actors" : [ {
+ "actor_id" : 234,
+ "actor_type" : "Team",
+ "bypass_mode" : "always"
+ } ],
+ "conditions" : {
+ "ref_name" : {
+ "include" : [ "refs/heads/main", "refs/heads/master" ],
+ "exclude" : [ "refs/heads/dev*" ]
+ }
+ },
+ "rules" : [ {
+ "type" : "commit_author_email_pattern",
+ "parameters" : {
+ "operator" : "contains",
+ "pattern" : "github"
+ }
+ } ]
+}
+
+
+### Create a tag protection state for a repository
+## Create a tag protection state for a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/tags/protection
+Content-Type: application/json
+Accept: application/json
+
+{
+ "pattern" : "v1.*"
+}
+
+
+### Create a repository using a template
+## Create a repository using a template
+POST https://api.github.com/repos/{{template_owner}}/{{template_repo}}/generate
+Content-Type: application/json
+Accept: application/json
+
+{
+ "owner" : "octocat",
+ "name" : "Hello-World",
+ "description" : "This is your first repository",
+ "include_all_branches" : false,
+ "private" : false
+}
+
+
+### Create a repository webhook
+## Create a repository webhook
+POST https://api.github.com/repos/{{owner}}/{{repo}}/hooks
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "web",
+ "active" : true,
+ "events" : [ "push", "pull_request" ],
+ "config" : {
+ "url" : "https://example.com/webhook",
+ "content_type" : "json",
+ "insecure_ssl" : "0"
+ }
+}
+
+
+### Decline a repository invitation
+## Decline a repository invitation
+DELETE https://api.github.com/user/repository_invitations/{{invitation_id}}
+Accept: application/json
+
+### Delete a repository
+## Delete a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}
+Accept: application/json
+
+### Delete access restrictions
+## Delete access restrictions
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions
+
+### Delete admin branch protection
+## Delete admin branch protection
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/enforce_admins
+Accept: application/json
+
+### Delete an environment
+## Delete an environment
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}
+
+### Delete an autolink reference from a repository
+## Delete an autolink reference from a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/autolinks/{{autolink_id}}
+Accept: application/json
+
+### Delete branch protection
+## Delete branch protection
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection
+Accept: application/json
+
+### Delete a commit comment
+## Delete a commit comment
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}
+Accept: application/json
+
+### Delete commit signature protection
+## Delete commit signature protection
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_signatures
+Accept: application/json
+
+### Delete a deploy key
+## Delete a deploy key
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/keys/{{key_id}}
+
+### Delete a deployment
+## Delete a deployment
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}
+Accept: application/json
+
+### Delete a deployment branch policy
+## Delete a deployment branch policy
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies/{{branch_policy_id}}
+
+### Delete a file
+## Delete a file
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/contents/{{path}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "message" : "my commit message",
+ "committer" : {
+ "name" : "Monalisa Octocat",
+ "email" : "octocat@github.com"
+ },
+ "sha" : "329688480d39049927147c162b9d2deaf885005f"
+}
+
+
+### Delete a repository invitation
+## Delete a repository invitation
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/invitations/{{invitation_id}}
+
+### Delete an organization repository ruleset
+## Delete an organization repository ruleset
+DELETE https://api.github.com/orgs/{{org}}/rulesets/{{ruleset_id}}
+Accept: application/json
+
+### Delete a GitHub Pages site
+## Delete a GitHub Pages site
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/pages
+Accept: application/json
+
+### Delete pull request review protection
+## Delete pull request review protection
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_pull_request_reviews
+Accept: application/json
+
+### Delete a release
+## Delete a release
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}
+
+### Delete a release asset
+## Delete a release asset
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/releases/assets/{{asset_id}}
+
+### Delete a repository ruleset
+## Delete a repository ruleset
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/{{ruleset_id}}
+Accept: application/json
+
+### Delete a tag protection state for a repository
+## Delete a tag protection state for a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/tags/protection/{{tag_protection_id}}
+Accept: application/json
+
+### Delete a repository webhook
+## Delete a repository webhook
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}
+Accept: application/json
+
+### Disable automated security fixes
+## Disable automated security fixes
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/automated-security-fixes
+
+### Disable a custom protection rule for an environment
+## Disable a custom protection rule for an environment
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules/{{protection_rule_id}}
+
+### Disable private vulnerability reporting for a repository
+## Disable private vulnerability reporting for a repository
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/private-vulnerability-reporting
+Accept: application/json
+Accept: application/scim+json
+
+### Disable vulnerability alerts
+## Disable vulnerability alerts
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/vulnerability-alerts
+
+### Download a repository archive (tar)
+## Download a repository archive (tar)
+GET https://api.github.com/repos/{{owner}}/{{repo}}/tarball/{{ref}}
+
+### Download a repository archive (zip)
+## Download a repository archive (zip)
+GET https://api.github.com/repos/{{owner}}/{{repo}}/zipball/{{ref}}
+
+### Enable automated security fixes
+## Enable automated security fixes
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/automated-security-fixes
+
+### Enable private vulnerability reporting for a repository
+## Enable private vulnerability reporting for a repository
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/private-vulnerability-reporting
+Accept: application/json
+Accept: application/scim+json
+
+### Enable vulnerability alerts
+## Enable vulnerability alerts
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/vulnerability-alerts
+
+### Generate release notes content for a release
+## Generate release notes content for a release
+POST https://api.github.com/repos/{{owner}}/{{repo}}/releases/generate-notes
+Content-Type: application/json
+Accept: application/json
+
+{
+ "tag_name" : "v1.0.0",
+ "target_commitish" : "main",
+ "previous_tag_name" : "v0.9.2",
+ "configuration_file_path" : ".github/custom_release_config.yml"
+}
+
+
+### Get a repository
+## Get a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}
+Accept: application/json
+
+### Get access restrictions
+## Get access restrictions
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions
+Accept: application/json
+
+### Get admin branch protection
+## Get admin branch protection
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/enforce_admins
+Accept: application/json
+
+### Get all deployment protection rules for an environment
+## Get all deployment protection rules for an environment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules
+Accept: application/json
+
+### List environments
+## List environments
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments
+Accept: application/json
+
+### Get all status check contexts
+## Get all status check contexts
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks/contexts
+Accept: application/json
+
+### Get all repository topics
+## Get all repository topics
+GET https://api.github.com/repos/{{owner}}/{{repo}}/topics
+Accept: application/json
+
+### Get apps with access to the protected branch
+## Get apps with access to the protected branch
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/apps
+Accept: application/json
+
+### Get an autolink reference of a repository
+## Get an autolink reference of a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/autolinks/{{autolink_id}}
+Accept: application/json
+
+### Get a branch
+## Get a branch
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}
+Accept: application/json
+
+### Get branch protection
+## Get branch protection
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection
+Accept: application/json
+
+### Get rules for a branch
+## Get rules for a branch
+GET https://api.github.com/repos/{{owner}}/{{repo}}/rules/branches/{{branch}}
+Accept: application/json
+
+### Get repository clones
+## Get repository clones
+GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/clones
+Accept: application/json
+
+### Get the weekly commit activity
+## Get the weekly commit activity
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stats/code_frequency
+Accept: application/json
+
+### Get repository permissions for a user
+## Get repository permissions for a user
+GET https://api.github.com/repos/{{owner}}/{{repo}}/collaborators/{{username}}/permission
+Accept: application/json
+
+### Get the combined status for a specific reference
+## Get the combined status for a specific reference
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/status
+Accept: application/json
+
+### Get a commit
+## Get a commit
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}
+Accept: application/json
+
+### Get the last year of commit activity
+## Get the last year of commit activity
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stats/commit_activity
+Accept: application/json
+
+### Get a commit comment
+## Get a commit comment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}
+Accept: application/json
+
+### Get commit signature protection
+## Get commit signature protection
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_signatures
+Accept: application/json
+
+### Get community profile metrics
+## Get community profile metrics
+GET https://api.github.com/repos/{{owner}}/{{repo}}/community/profile
+Accept: application/json
+
+### Get repository content
+## Get repository content
+GET https://api.github.com/repos/{{owner}}/{{repo}}/contents/{{path}}
+Accept: application/vnd.github.object
+Accept: application/json
+
+### Get all contributor commit activity
+## Get all contributor commit activity
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stats/contributors
+Accept: application/json
+
+### Get a custom deployment protection rule
+## Get a custom deployment protection rule
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules/{{protection_rule_id}}
+Accept: application/json
+
+### Get all custom property values for a repository
+## Get all custom property values for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/properties/values
+Accept: application/json
+
+### Get a deploy key
+## Get a deploy key
+GET https://api.github.com/repos/{{owner}}/{{repo}}/keys/{{key_id}}
+Accept: application/json
+
+### Get a deployment
+## Get a deployment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}
+Accept: application/json
+
+### Get a deployment branch policy
+## Get a deployment branch policy
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies/{{branch_policy_id}}
+Accept: application/json
+
+### Get a deployment status
+## Get a deployment status
+GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}/statuses/{{status_id}}
+Accept: application/json
+
+### Get an environment
+## Get an environment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}
+Accept: application/json
+
+### Get latest Pages build
+## Get latest Pages build
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds/latest
+Accept: application/json
+
+### Get the latest release
+## Get the latest release
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/latest
+Accept: application/json
+
+### Get an organization rule suite
+## Get an organization rule suite
+GET https://api.github.com/orgs/{{org}}/rulesets/rule-suites/{{rule_suite_id}}
+Accept: application/json
+
+### List organization rule suites
+## List organization rule suites
+GET https://api.github.com/orgs/{{org}}/rulesets/rule-suites
+Accept: application/json
+
+### Get an organization repository ruleset
+## Get an organization repository ruleset
+GET https://api.github.com/orgs/{{org}}/rulesets/{{ruleset_id}}
+Accept: application/json
+
+### Get all organization repository rulesets
+## Get all organization repository rulesets
+GET https://api.github.com/orgs/{{org}}/rulesets
+Accept: application/json
+
+### Get a GitHub Pages site
+## Get a GitHub Pages site
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages
+Accept: application/json
+
+### Get GitHub Pages build
+## Get GitHub Pages build
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds/{{build_id}}
+Accept: application/json
+
+### Get the status of a GitHub Pages deployment
+## Get the status of a GitHub Pages deployment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/deployments/{{pages_deployment_id}}
+Accept: application/json
+
+### Get a DNS health check for GitHub Pages
+## Get a DNS health check for GitHub Pages
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/health
+Accept: application/json
+
+### Get the weekly commit count
+## Get the weekly commit count
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stats/participation
+Accept: application/json
+
+### Get pull request review protection
+## Get pull request review protection
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_pull_request_reviews
+Accept: application/json
+
+### Get the hourly commit count for each day
+## Get the hourly commit count for each day
+GET https://api.github.com/repos/{{owner}}/{{repo}}/stats/punch_card
+Accept: application/json
+
+### Get a repository README
+## Get a repository README
+GET https://api.github.com/repos/{{owner}}/{{repo}}/readme
+Accept: application/json
+
+### Get a repository README for a directory
+## Get a repository README for a directory
+GET https://api.github.com/repos/{{owner}}/{{repo}}/readme/{{dir}}
+Accept: application/json
+
+### Get a release
+## Get a release
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}
+Accept: application/json
+
+### Get a release asset
+## Get a release asset
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/assets/{{asset_id}}
+Accept: application/json
+
+### Get a release by tag name
+## Get a release by tag name
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/tags/{{tag}}
+Accept: application/json
+
+### Get a repository rule suite
+## Get a repository rule suite
+GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/rule-suites/{{rule_suite_id}}
+Accept: application/json
+
+### List repository rule suites
+## List repository rule suites
+GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/rule-suites
+Accept: application/json
+
+### Get a repository ruleset
+## Get a repository ruleset
+GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/{{ruleset_id}}
+Accept: application/json
+
+### Get all repository rulesets
+## Get all repository rulesets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/rulesets
+Accept: application/json
+
+### Get status checks protection
+## Get status checks protection
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks
+Accept: application/json
+
+### Get teams with access to the protected branch
+## Get teams with access to the protected branch
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/teams
+Accept: application/json
+
+### Get top referral paths
+## Get top referral paths
+GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/popular/paths
+Accept: application/json
+
+### Get top referral sources
+## Get top referral sources
+GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/popular/referrers
+Accept: application/json
+
+### Get users with access to the protected branch
+## Get users with access to the protected branch
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/users
+Accept: application/json
+
+### Get page views
+## Get page views
+GET https://api.github.com/repos/{{owner}}/{{repo}}/traffic/views
+Accept: application/json
+
+### Get a repository webhook
+## Get a repository webhook
+GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}
+Accept: application/json
+
+### Get a webhook configuration for a repository
+## Get a webhook configuration for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/config
+Accept: application/json
+
+### Get a delivery for a repository webhook
+## Get a delivery for a repository webhook
+GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/deliveries/{{delivery_id}}
+Accept: application/json
+Accept: application/scim+json
+
+### List repository activities
+## List repository activities
+GET https://api.github.com/repos/{{owner}}/{{repo}}/activity
+Accept: application/json
+
+### Get all autolinks of a repository
+## Get all autolinks of a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/autolinks
+Accept: application/json
+
+### List branches
+## List branches
+GET https://api.github.com/repos/{{owner}}/{{repo}}/branches
+Accept: application/json
+
+### List branches for HEAD commit
+## List branches for HEAD commit
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/branches-where-head
+Accept: application/json
+
+### List repository collaborators
+## List repository collaborators
+GET https://api.github.com/repos/{{owner}}/{{repo}}/collaborators
+Accept: application/json
+
+### List commit comments
+## List commit comments
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/comments
+Accept: application/json
+
+### List commit comments for a repository
+## List commit comments for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/comments
+Accept: application/json
+
+### List commit statuses for a reference
+## List commit statuses for a reference
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{ref}}/statuses
+Accept: application/json
+
+### List commits
+## List commits
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits
+Accept: application/json
+Accept: application/scim+json
+
+### List repository contributors
+## List repository contributors
+GET https://api.github.com/repos/{{owner}}/{{repo}}/contributors
+Accept: application/json
+
+### List custom deployment rule integrations available for an environment
+## List custom deployment rule integrations available for an environment
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment_protection_rules/apps
+Accept: application/json
+
+### List deploy keys
+## List deploy keys
+GET https://api.github.com/repos/{{owner}}/{{repo}}/keys
+Accept: application/json
+
+### List deployment branch policies
+## List deployment branch policies
+GET https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies
+Accept: application/json
+
+### List deployment statuses
+## List deployment statuses
+GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments/{{deployment_id}}/statuses
+Accept: application/json
+
+### List deployments
+## List deployments
+GET https://api.github.com/repos/{{owner}}/{{repo}}/deployments
+Accept: application/json
+
+### List repositories for the authenticated user
+## List repositories for the authenticated user
+GET https://api.github.com/user/repos
+Accept: application/json
+
+### List organization repositories
+## List organization repositories
+GET https://api.github.com/orgs/{{org}}/repos
+Accept: application/json
+
+### List repositories for a user
+## List repositories for a user
+GET https://api.github.com/users/{{username}}/repos
+Accept: application/json
+
+### List forks
+## List forks
+GET https://api.github.com/repos/{{owner}}/{{repo}}/forks
+Accept: application/json
+Accept: application/scim+json
+
+### List repository invitations
+## List repository invitations
+GET https://api.github.com/repos/{{owner}}/{{repo}}/invitations
+Accept: application/json
+
+### List repository invitations for the authenticated user
+## List repository invitations for the authenticated user
+GET https://api.github.com/user/repository_invitations
+Accept: application/json
+
+### List repository languages
+## List repository languages
+GET https://api.github.com/repos/{{owner}}/{{repo}}/languages
+Accept: application/json
+
+### List GitHub Pages builds
+## List GitHub Pages builds
+GET https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds
+Accept: application/json
+
+### List public repositories
+## List public repositories
+GET https://api.github.com/repositories
+Accept: application/json
+
+### List pull requests associated with a commit
+## List pull requests associated with a commit
+GET https://api.github.com/repos/{{owner}}/{{repo}}/commits/{{commit_sha}}/pulls
+Accept: application/json
+
+### List release assets
+## List release assets
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets
+Accept: application/json
+
+### List releases
+## List releases
+GET https://api.github.com/repos/{{owner}}/{{repo}}/releases
+Accept: application/json
+
+### List tag protection states for a repository
+## List tag protection states for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/tags/protection
+Accept: application/json
+
+### List repository tags
+## List repository tags
+GET https://api.github.com/repos/{{owner}}/{{repo}}/tags
+Accept: application/json
+
+### List repository teams
+## List repository teams
+GET https://api.github.com/repos/{{owner}}/{{repo}}/teams
+Accept: application/json
+
+### List deliveries for a repository webhook
+## List deliveries for a repository webhook
+GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/deliveries
+Accept: application/json
+Accept: application/scim+json
+
+### List repository webhooks
+## List repository webhooks
+GET https://api.github.com/repos/{{owner}}/{{repo}}/hooks
+Accept: application/json
+
+### Merge a branch
+## Merge a branch
+POST https://api.github.com/repos/{{owner}}/{{repo}}/merges
+Content-Type: application/json
+Accept: application/json
+
+{
+ "base" : "master",
+ "head" : "cool_feature",
+ "commit_message" : "Shipped cool_feature!"
+}
+
+
+### Sync a fork branch with the upstream repository
+## Sync a fork branch with the upstream repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/merge-upstream
+Content-Type: application/json
+Accept: application/json
+
+{
+ "branch" : "main"
+}
+
+
+### Ping a repository webhook
+## Ping a repository webhook
+POST https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/pings
+Accept: application/json
+
+### Redeliver a delivery for a repository webhook
+## Redeliver a delivery for a repository webhook
+POST https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/deliveries/{{delivery_id}}/attempts
+Accept: application/json
+Accept: application/scim+json
+
+### Remove app access restrictions
+## Remove app access restrictions
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/apps
+Content-Type: application/json
+Accept: application/json
+
+{
+ "apps" : [ "my-app" ]
+}
+
+
+### Remove a repository collaborator
+## Remove a repository collaborator
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/collaborators/{{username}}
+Accept: application/json
+
+### Remove status check contexts
+## Remove status check contexts
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks/contexts
+Content-Type: application/json
+Accept: application/json
+
+{
+ "contexts" : [ "continuous-integration/jenkins" ]
+}
+
+
+### Remove status check protection
+## Remove status check protection
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks
+
+### Remove team access restrictions
+## Remove team access restrictions
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "teams" : [ "octocats" ]
+}
+
+
+### Remove user access restrictions
+## Remove user access restrictions
+DELETE https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "users" : [ "octocat" ]
+}
+
+
+### Rename a branch
+## Rename a branch
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/rename
+Content-Type: application/json
+Accept: application/json
+
+{
+ "new_name" : "my_renamed_branch"
+}
+
+
+### Replace all repository topics
+## Replace all repository topics
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/topics
+Content-Type: application/json
+Accept: application/json
+
+{
+ "names" : [ "octocat", "atom", "electron", "api" ]
+}
+
+
+### Request a GitHub Pages build
+## Request a GitHub Pages build
+POST https://api.github.com/repos/{{owner}}/{{repo}}/pages/builds
+Accept: application/json
+
+### Set admin branch protection
+## Set admin branch protection
+POST https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/enforce_admins
+Accept: application/json
+
+### Set app access restrictions
+## Set app access restrictions
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/apps
+Content-Type: application/json
+Accept: application/json
+
+{
+ "apps" : [ "octoapp" ]
+}
+
+
+### Set status check contexts
+## Set status check contexts
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks/contexts
+Content-Type: application/json
+Accept: application/json
+
+{
+ "contexts" : [ "continuous-integration/travis-ci" ]
+}
+
+
+### Set team access restrictions
+## Set team access restrictions
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "teams" : [ "justice-league" ]
+}
+
+
+### Set user access restrictions
+## Set user access restrictions
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/restrictions/users
+Content-Type: application/json
+Accept: application/json
+
+{
+ "users" : [ "octocat" ]
+}
+
+
+### Test the push repository webhook
+## Test the push repository webhook
+POST https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/tests
+Accept: application/json
+
+### Transfer a repository
+## Transfer a repository
+POST https://api.github.com/repos/{{owner}}/{{repo}}/transfer
+Content-Type: application/json
+Accept: application/json
+
+{
+ "new_owner" : "github",
+ "team_ids" : [ 12, 345 ],
+ "new_name" : "octorepo"
+}
+
+
+### Update a repository
+## Update a repository
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Hello-World",
+ "description" : "This is your first repository",
+ "homepage" : "https://github.com",
+ "private" : true,
+ "has_issues" : true,
+ "has_projects" : true,
+ "has_wiki" : true
+}
+
+
+### Update branch protection
+## Update branch protection
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection
+Content-Type: application/json
+Accept: application/json
+
+{
+ "required_status_checks" : {
+ "strict" : true,
+ "contexts" : [ "continuous-integration/travis-ci" ]
+ },
+ "enforce_admins" : true,
+ "required_pull_request_reviews" : {
+ "dismissal_restrictions" : {
+ "users" : [ "octocat" ],
+ "teams" : [ "justice-league" ]
+ },
+ "dismiss_stale_reviews" : true,
+ "require_code_owner_reviews" : true,
+ "required_approving_review_count" : 2,
+ "require_last_push_approval" : true,
+ "bypass_pull_request_allowances" : {
+ "users" : [ "octocat" ],
+ "teams" : [ "justice-league" ]
+ }
+ },
+ "restrictions" : {
+ "users" : [ "octocat" ],
+ "teams" : [ "justice-league" ],
+ "apps" : [ "super-ci" ]
+ },
+ "required_linear_history" : true,
+ "allow_force_pushes" : true,
+ "allow_deletions" : true,
+ "block_creations" : true,
+ "required_conversation_resolution" : true,
+ "lock_branch" : true,
+ "allow_fork_syncing" : true
+}
+
+
+### Update a commit comment
+## Update a commit comment
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/comments/{{comment_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Nice change"
+}
+
+
+### Update a deployment branch policy
+## Update a deployment branch policy
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/environments/{{environment_name}}/deployment-branch-policies/{{branch_policy_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "release/*"
+}
+
+
+### Update information about a GitHub Pages site
+## Update information about a GitHub Pages site
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/pages
+Content-Type: application/json
+Accept: application/json
+Accept: application/scim+json
+
+{
+ "cname" : "octocatblog.com",
+ "source" : {
+ "branch" : "main",
+ "path" : "/"
+ }
+}
+
+
+### Update a repository invitation
+## Update a repository invitation
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/invitations/{{invitation_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permissions" : "write"
+}
+
+
+### Update an organization repository ruleset
+## Update an organization repository ruleset
+PUT https://api.github.com/orgs/{{org}}/rulesets/{{ruleset_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "super cool ruleset",
+ "target" : "branch",
+ "enforcement" : "active",
+ "bypass_actors" : [ {
+ "actor_id" : 234,
+ "actor_type" : "Team",
+ "bypass_mode" : "always"
+ } ],
+ "conditions" : {
+ "ref_name" : {
+ "include" : [ "refs/heads/main", "refs/heads/master" ],
+ "exclude" : [ "refs/heads/dev*" ]
+ },
+ "repository_name" : {
+ "include" : [ "important_repository", "another_important_repository" ],
+ "exclude" : [ "unimportant_repository" ],
+ "protected" : true
+ }
+ },
+ "rules" : [ {
+ "type" : "commit_author_email_pattern",
+ "parameters" : {
+ "operator" : "contains",
+ "pattern" : "github"
+ }
+ } ]
+}
+
+
+### Update pull request review protection
+## Update pull request review protection
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_pull_request_reviews
+Content-Type: application/json
+Accept: application/json
+
+{
+ "dismissal_restrictions" : {
+ "users" : [ "octocat" ],
+ "teams" : [ "justice-league" ],
+ "apps" : [ "octoapp" ]
+ },
+ "bypass_pull_request_allowances" : {
+ "users" : [ "octocat" ],
+ "teams" : [ "justice-league" ],
+ "apps" : [ "octoapp" ]
+ },
+ "dismiss_stale_reviews" : true,
+ "require_code_owner_reviews" : true,
+ "required_approving_review_count" : 2,
+ "require_last_push_approval" : true
+}
+
+
+### Update a release
+## Update a release
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "tag_name" : "v1.0.0",
+ "target_commitish" : "master",
+ "name" : "v1.0.0",
+ "body" : "Description of the release",
+ "draft" : false,
+ "prerelease" : false
+}
+
+
+### Update a release asset
+## Update a release asset
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/releases/assets/{{asset_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "foo-1.0.0-osx.zip",
+ "label" : "Mac binary"
+}
+
+
+### Update a repository ruleset
+## Update a repository ruleset
+PUT https://api.github.com/repos/{{owner}}/{{repo}}/rulesets/{{ruleset_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "super cool ruleset",
+ "target" : "branch",
+ "enforcement" : "active",
+ "bypass_actors" : [ {
+ "actor_id" : 234,
+ "actor_type" : "Team",
+ "bypass_mode" : "always"
+ } ],
+ "conditions" : {
+ "ref_name" : {
+ "include" : [ "refs/heads/main", "refs/heads/master" ],
+ "exclude" : [ "refs/heads/dev*" ]
+ }
+ },
+ "rules" : [ {
+ "type" : "commit_author_email_pattern",
+ "parameters" : {
+ "operator" : "contains",
+ "pattern" : "github"
+ }
+ } ]
+}
+
+
+### Update status check protection
+## Update status check protection
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/branches/{{branch}}/protection/required_status_checks
+Content-Type: application/json
+Accept: application/json
+
+{
+ "strict" : true,
+ "contexts" : [ "continuous-integration/travis-ci" ]
+}
+
+
+### Update a repository webhook
+## Update a repository webhook
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "active" : true,
+ "add_events" : [ "pull_request" ]
+}
+
+
+### Update a webhook configuration for a repository
+## Update a webhook configuration for a repository
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/hooks/{{hook_id}}/config
+Content-Type: application/json
+Accept: application/json
+
+{
+ "content_type" : "json",
+ "url" : "https://example.com/webhook"
+}
+
+
+### Upload a release asset
+## Upload a release asset
+POST https://api.github.com/repos/{{owner}}/{{repo}}/releases/{{release_id}}/assets
+Content-Type: application/octet-stream
+Accept: application/json
+
+
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/SearchApi.http b/samples/client/github/jetbrains/http/client/Apis/SearchApi.http
new file mode 100644
index 000000000000..ef3094ae09bf
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/SearchApi.http
@@ -0,0 +1,36 @@
+## SearchApi
+
+### Search code
+## Search code
+GET https://api.github.com/search/code
+Accept: application/json
+
+### Search commits
+## Search commits
+GET https://api.github.com/search/commits
+Accept: application/json
+
+### Search issues and pull requests
+## Search issues and pull requests
+GET https://api.github.com/search/issues
+Accept: application/json
+
+### Search labels
+## Search labels
+GET https://api.github.com/search/labels
+Accept: application/json
+
+### Search repositories
+## Search repositories
+GET https://api.github.com/search/repositories
+Accept: application/json
+
+### Search topics
+## Search topics
+GET https://api.github.com/search/topics
+Accept: application/json
+
+### Search users
+## Search users
+GET https://api.github.com/search/users
+Accept: application/json
diff --git a/samples/client/github/jetbrains/http/client/Apis/SecretScanningApi.http b/samples/client/github/jetbrains/http/client/Apis/SecretScanningApi.http
new file mode 100644
index 000000000000..cee20eb1ff49
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/SecretScanningApi.http
@@ -0,0 +1,38 @@
+## SecretScanningApi
+
+### Get a secret scanning alert
+## Get a secret scanning alert
+GET https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts/{{alert_number}}
+Accept: application/json
+
+### List secret scanning alerts for an enterprise
+## List secret scanning alerts for an enterprise
+GET https://api.github.com/enterprises/{{enterprise}}/secret-scanning/alerts
+Accept: application/json
+
+### List secret scanning alerts for an organization
+## List secret scanning alerts for an organization
+GET https://api.github.com/orgs/{{org}}/secret-scanning/alerts
+Accept: application/json
+
+### List secret scanning alerts for a repository
+## List secret scanning alerts for a repository
+GET https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts
+Accept: application/json
+
+### List locations for a secret scanning alert
+## List locations for a secret scanning alert
+GET https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts/{{alert_number}}/locations
+Accept: application/json
+
+### Update a secret scanning alert
+## Update a secret scanning alert
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/secret-scanning/alerts/{{alert_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "state" : "resolved",
+ "resolution" : "false_positive"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/SecurityAdvisoriesApi.http b/samples/client/github/jetbrains/http/client/Apis/SecurityAdvisoriesApi.http
new file mode 100644
index 000000000000..524caffffae4
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/SecurityAdvisoriesApi.http
@@ -0,0 +1,106 @@
+## SecurityAdvisoriesApi
+
+### Create a temporary private fork
+## Create a temporary private fork
+POST https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories/{{ghsa_id}}/forks
+Accept: application/json
+Accept: application/scim+json
+
+### Privately report a security vulnerability
+## Privately report a security vulnerability
+POST https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories/reports
+Content-Type: application/json
+Accept: application/json
+
+{
+ "summary" : "A newly discovered vulnerability",
+ "description" : "A more in-depth description of what the problem is.",
+ "severity" : "high",
+ "vulnerabilities" : [ {
+ "package" : {
+ "name" : "a-package",
+ "ecosystem" : "npm"
+ },
+ "vulnerable_version_range" : "< 1.0.0",
+ "patched_versions" : "1.0.0",
+ "vulnerable_functions" : [ "important_function" ]
+ } ],
+ "cwe_ids" : [ "CWE-123" ]
+}
+
+
+### Create a repository security advisory
+## Create a repository security advisory
+POST https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories
+Content-Type: application/json
+Accept: application/json
+
+{
+ "summary" : "A new important advisory",
+ "description" : "A more in-depth description of what the problem is.",
+ "severity" : "high",
+ "cve_id" : null,
+ "vulnerabilities" : [ {
+ "package" : {
+ "name" : "a-package",
+ "ecosystem" : "npm"
+ },
+ "vulnerable_version_range" : "< 1.0.0",
+ "patched_versions" : "1.0.0",
+ "vulnerable_functions" : [ "important_function" ]
+ } ],
+ "cwe_ids" : [ "CWE-1101", "CWE-20" ],
+ "credits" : [ {
+ "login" : "monalisa",
+ "type" : "reporter"
+ }, {
+ "login" : "octocat",
+ "type" : "analyst"
+ } ]
+}
+
+
+### Request a CVE for a repository security advisory
+## Request a CVE for a repository security advisory
+POST https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories/{{ghsa_id}}/cve
+Accept: application/json
+Accept: application/scim+json
+
+### Get a global security advisory
+## Get a global security advisory
+GET https://api.github.com/advisories/{{ghsa_id}}
+Accept: application/json
+
+### Get a repository security advisory
+## Get a repository security advisory
+GET https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories/{{ghsa_id}}
+Accept: application/json
+
+### List global security advisories
+## List global security advisories
+GET https://api.github.com/advisories
+Accept: application/json
+
+### List repository security advisories for an organization
+## List repository security advisories for an organization
+GET https://api.github.com/orgs/{{org}}/security-advisories
+Accept: application/json
+Accept: application/scim+json
+
+### List repository security advisories
+## List repository security advisories
+GET https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories
+Accept: application/json
+Accept: application/scim+json
+
+### Update a repository security advisory
+## Update a repository security advisory
+PATCH https://api.github.com/repos/{{owner}}/{{repo}}/security-advisories/{{ghsa_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "severity" : "critical",
+ "state" : "published"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/TeamsApi.http b/samples/client/github/jetbrains/http/client/Apis/TeamsApi.http
new file mode 100644
index 000000000000..fe9b1d98add8
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/TeamsApi.http
@@ -0,0 +1,402 @@
+## TeamsApi
+
+### Add team member (Legacy)
+## Add team member (Legacy)
+PUT https://api.github.com/teams/{{team_id}}/members/{{username}}
+Accept: application/json
+
+### Add or update team membership for a user
+## Add or update team membership for a user
+PUT https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/memberships/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "role" : "maintainer"
+}
+
+
+### Add or update team membership for a user (Legacy)
+## Add or update team membership for a user (Legacy)
+PUT https://api.github.com/teams/{{team_id}}/memberships/{{username}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "role" : "member"
+}
+
+
+### Add or update team project permissions
+## Add or update team project permissions
+PUT https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects/{{project_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permission" : "write"
+}
+
+
+### Add or update team project permissions (Legacy)
+## Add or update team project permissions (Legacy)
+PUT https://api.github.com/teams/{{team_id}}/projects/{{project_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permission" : "read"
+}
+
+
+### Add or update team repository permissions
+## Add or update team repository permissions
+PUT https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos/{{owner}}/{{repo}}
+Content-Type: application/json
+
+{
+ "permission" : "push"
+}
+
+
+### Add or update team repository permissions (Legacy)
+## Add or update team repository permissions (Legacy)
+PUT https://api.github.com/teams/{{team_id}}/repos/{{owner}}/{{repo}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "permission" : "push"
+}
+
+
+### Check team permissions for a project
+## Check team permissions for a project
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects/{{project_id}}
+Accept: application/json
+
+### Check team permissions for a project (Legacy)
+## Check team permissions for a project (Legacy)
+GET https://api.github.com/teams/{{team_id}}/projects/{{project_id}}
+Accept: application/json
+
+### Check team permissions for a repository
+## Check team permissions for a repository
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos/{{owner}}/{{repo}}
+Accept: application/json
+
+### Check team permissions for a repository (Legacy)
+## Check team permissions for a repository (Legacy)
+GET https://api.github.com/teams/{{team_id}}/repos/{{owner}}/{{repo}}
+Accept: application/json
+
+### Create a team
+## Create a team
+POST https://api.github.com/orgs/{{org}}/teams
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Justice League",
+ "description" : "A great team",
+ "permission" : "push",
+ "notification_setting" : "notifications_enabled",
+ "privacy" : "closed"
+}
+
+
+### Create a discussion comment
+## Create a discussion comment
+POST https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Do you like apples?"
+}
+
+
+### Create a discussion comment (Legacy)
+## Create a discussion comment (Legacy)
+POST https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Do you like apples?"
+}
+
+
+### Create a discussion
+## Create a discussion
+POST https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Our first team post",
+ "body" : "Hi! This is an area for us to collaborate as a team."
+}
+
+
+### Create a discussion (Legacy)
+## Create a discussion (Legacy)
+POST https://api.github.com/teams/{{team_id}}/discussions
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Our first team post",
+ "body" : "Hi! This is an area for us to collaborate as a team."
+}
+
+
+### Delete a discussion comment
+## Delete a discussion comment
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+
+### Delete a discussion comment (Legacy)
+## Delete a discussion comment (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+
+### Delete a discussion
+## Delete a discussion
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}
+
+### Delete a discussion (Legacy)
+## Delete a discussion (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}
+
+### Delete a team
+## Delete a team
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}
+
+### Delete a team (Legacy)
+## Delete a team (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}
+Accept: application/json
+
+### Get a team by name
+## Get a team by name
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}
+Accept: application/json
+
+### Get a discussion comment
+## Get a discussion comment
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+Accept: application/json
+
+### Get a discussion comment (Legacy)
+## Get a discussion comment (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+Accept: application/json
+
+### Get a discussion
+## Get a discussion
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}
+Accept: application/json
+
+### Get a discussion (Legacy)
+## Get a discussion (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}
+Accept: application/json
+
+### Get a team (Legacy)
+## Get a team (Legacy)
+GET https://api.github.com/teams/{{team_id}}
+Accept: application/json
+
+### Get team member (Legacy)
+## Get team member (Legacy)
+GET https://api.github.com/teams/{{team_id}}/members/{{username}}
+
+### Get team membership for a user
+## Get team membership for a user
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/memberships/{{username}}
+Accept: application/json
+
+### Get team membership for a user (Legacy)
+## Get team membership for a user (Legacy)
+GET https://api.github.com/teams/{{team_id}}/memberships/{{username}}
+Accept: application/json
+
+### List teams
+## List teams
+GET https://api.github.com/orgs/{{org}}/teams
+Accept: application/json
+
+### List child teams
+## List child teams
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/teams
+Accept: application/json
+
+### List child teams (Legacy)
+## List child teams (Legacy)
+GET https://api.github.com/teams/{{team_id}}/teams
+Accept: application/json
+
+### List discussion comments
+## List discussion comments
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments
+Accept: application/json
+
+### List discussion comments (Legacy)
+## List discussion comments (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments
+Accept: application/json
+
+### List discussions
+## List discussions
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions
+Accept: application/json
+
+### List discussions (Legacy)
+## List discussions (Legacy)
+GET https://api.github.com/teams/{{team_id}}/discussions
+Accept: application/json
+
+### List teams for the authenticated user
+## List teams for the authenticated user
+GET https://api.github.com/user/teams
+Accept: application/json
+
+### List team members
+## List team members
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/members
+Accept: application/json
+
+### List team members (Legacy)
+## List team members (Legacy)
+GET https://api.github.com/teams/{{team_id}}/members
+Accept: application/json
+
+### List pending team invitations
+## List pending team invitations
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/invitations
+Accept: application/json
+
+### List pending team invitations (Legacy)
+## List pending team invitations (Legacy)
+GET https://api.github.com/teams/{{team_id}}/invitations
+Accept: application/json
+
+### List team projects
+## List team projects
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects
+Accept: application/json
+
+### List team projects (Legacy)
+## List team projects (Legacy)
+GET https://api.github.com/teams/{{team_id}}/projects
+Accept: application/json
+
+### List team repositories
+## List team repositories
+GET https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos
+Accept: application/json
+
+### List team repositories (Legacy)
+## List team repositories (Legacy)
+GET https://api.github.com/teams/{{team_id}}/repos
+Accept: application/json
+
+### Remove team member (Legacy)
+## Remove team member (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/members/{{username}}
+
+### Remove team membership for a user
+## Remove team membership for a user
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/memberships/{{username}}
+
+### Remove team membership for a user (Legacy)
+## Remove team membership for a user (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/memberships/{{username}}
+
+### Remove a project from a team
+## Remove a project from a team
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/projects/{{project_id}}
+
+### Remove a project from a team (Legacy)
+## Remove a project from a team (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/projects/{{project_id}}
+Accept: application/json
+
+### Remove a repository from a team
+## Remove a repository from a team
+DELETE https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/repos/{{owner}}/{{repo}}
+
+### Remove a repository from a team (Legacy)
+## Remove a repository from a team (Legacy)
+DELETE https://api.github.com/teams/{{team_id}}/repos/{{owner}}/{{repo}}
+
+### Update a discussion comment
+## Update a discussion comment
+PATCH https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Do you like pineapples?"
+}
+
+
+### Update a discussion comment (Legacy)
+## Update a discussion comment (Legacy)
+PATCH https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}/comments/{{comment_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "body" : "Do you like pineapples?"
+}
+
+
+### Update a discussion
+## Update a discussion
+PATCH https://api.github.com/orgs/{{org}}/teams/{{team_slug}}/discussions/{{discussion_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Welcome to our first team post"
+}
+
+
+### Update a discussion (Legacy)
+## Update a discussion (Legacy)
+PATCH https://api.github.com/teams/{{team_id}}/discussions/{{discussion_number}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "Welcome to our first team post"
+}
+
+
+### Update a team
+## Update a team
+PATCH https://api.github.com/orgs/{{org}}/teams/{{team_slug}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "new team name",
+ "description" : "new team description",
+ "privacy" : "closed",
+ "notification_setting" : "notifications_enabled"
+}
+
+
+### Update a team (Legacy)
+## Update a team (Legacy)
+PATCH https://api.github.com/teams/{{team_id}}
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "new team name",
+ "description" : "new team description",
+ "privacy" : "closed",
+ "notification_setting" : "notifications_enabled"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/Apis/UsersApi.http b/samples/client/github/jetbrains/http/client/Apis/UsersApi.http
new file mode 100644
index 000000000000..99f25ec325b4
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/Apis/UsersApi.http
@@ -0,0 +1,263 @@
+## UsersApi
+
+### Add an email address for the authenticated user
+## Add an email address for the authenticated user
+POST https://api.github.com/user/emails
+Content-Type: application/json
+Accept: application/json
+
+{
+ "emails" : [ "octocat@github.com", "mona@github.com", "octocat@octocat.org" ]
+}
+
+
+### Add social accounts for the authenticated user
+## Add social accounts for the authenticated user
+POST https://api.github.com/user/social_accounts
+Content-Type: application/json
+Accept: application/json
+
+{
+ "account_urls" : [ "https://facebook.com/GitHub", "https://www.youtube.com/@GitHub" ]
+}
+
+
+### Block a user
+## Block a user
+PUT https://api.github.com/user/blocks/{{username}}
+Accept: application/json
+
+### Check if a user is blocked by the authenticated user
+## Check if a user is blocked by the authenticated user
+GET https://api.github.com/user/blocks/{{username}}
+Accept: application/json
+
+### Check if a user follows another user
+## Check if a user follows another user
+GET https://api.github.com/users/{{username}}/following/{{target_user}}
+
+### Check if a person is followed by the authenticated user
+## Check if a person is followed by the authenticated user
+GET https://api.github.com/user/following/{{username}}
+Accept: application/json
+
+### Create a GPG key for the authenticated user
+## Create a GPG key for the authenticated user
+POST https://api.github.com/user/gpg_keys
+Content-Type: application/json
+Accept: application/json
+
+{
+ "name" : "Octocat's GPG Key",
+ "armored_public_key" : "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1\n\nmQINBFnZ2ZIBEADQ2Z7Z7\n-----END PGP PUBLIC KEY BLOCK-----"
+}
+
+
+### Create a public SSH key for the authenticated user
+## Create a public SSH key for the authenticated user
+POST https://api.github.com/user/keys
+Content-Type: application/json
+Accept: application/json
+
+{
+ "title" : "ssh-rsa AAAAB3NzaC1yc2EAAA",
+ "key" : "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
+}
+
+
+### Create a SSH signing key for the authenticated user
+## Create a SSH signing key for the authenticated user
+POST https://api.github.com/user/ssh_signing_keys
+Content-Type: application/json
+Accept: application/json
+
+{
+ "key" : "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "title" : "ssh-rsa AAAAB3NzaC1yc2EAAA"
+}
+
+
+### Delete an email address for the authenticated user
+## Delete an email address for the authenticated user
+DELETE https://api.github.com/user/emails
+Content-Type: application/json
+Accept: application/json
+
+{
+ "emails" : [ "octocat@github.com", "mona@github.com" ]
+}
+
+
+### Delete a GPG key for the authenticated user
+## Delete a GPG key for the authenticated user
+DELETE https://api.github.com/user/gpg_keys/{{gpg_key_id}}
+Accept: application/json
+
+### Delete a public SSH key for the authenticated user
+## Delete a public SSH key for the authenticated user
+DELETE https://api.github.com/user/keys/{{key_id}}
+Accept: application/json
+
+### Delete social accounts for the authenticated user
+## Delete social accounts for the authenticated user
+DELETE https://api.github.com/user/social_accounts
+Content-Type: application/json
+Accept: application/json
+
+{
+ "account_urls" : [ "https://facebook.com/GitHub", "https://www.youtube.com/@GitHub" ]
+}
+
+
+### Delete an SSH signing key for the authenticated user
+## Delete an SSH signing key for the authenticated user
+DELETE https://api.github.com/user/ssh_signing_keys/{{ssh_signing_key_id}}
+Accept: application/json
+
+### Follow a user
+## Follow a user
+PUT https://api.github.com/user/following/{{username}}
+Accept: application/json
+
+### Get the authenticated user
+## Get the authenticated user
+GET https://api.github.com/user
+Accept: application/json
+
+### Get a user
+## Get a user
+GET https://api.github.com/users/{{username}}
+Accept: application/json
+
+### Get contextual information for a user
+## Get contextual information for a user
+GET https://api.github.com/users/{{username}}/hovercard
+Accept: application/json
+
+### Get a GPG key for the authenticated user
+## Get a GPG key for the authenticated user
+GET https://api.github.com/user/gpg_keys/{{gpg_key_id}}
+Accept: application/json
+
+### Get a public SSH key for the authenticated user
+## Get a public SSH key for the authenticated user
+GET https://api.github.com/user/keys/{{key_id}}
+Accept: application/json
+
+### Get an SSH signing key for the authenticated user
+## Get an SSH signing key for the authenticated user
+GET https://api.github.com/user/ssh_signing_keys/{{ssh_signing_key_id}}
+Accept: application/json
+
+### List users
+## List users
+GET https://api.github.com/users
+Accept: application/json
+
+### List users blocked by the authenticated user
+## List users blocked by the authenticated user
+GET https://api.github.com/user/blocks
+Accept: application/json
+
+### List email addresses for the authenticated user
+## List email addresses for the authenticated user
+GET https://api.github.com/user/emails
+Accept: application/json
+
+### List the people the authenticated user follows
+## List the people the authenticated user follows
+GET https://api.github.com/user/following
+Accept: application/json
+
+### List followers of the authenticated user
+## List followers of the authenticated user
+GET https://api.github.com/user/followers
+Accept: application/json
+
+### List followers of a user
+## List followers of a user
+GET https://api.github.com/users/{{username}}/followers
+Accept: application/json
+
+### List the people a user follows
+## List the people a user follows
+GET https://api.github.com/users/{{username}}/following
+Accept: application/json
+
+### List GPG keys for the authenticated user
+## List GPG keys for the authenticated user
+GET https://api.github.com/user/gpg_keys
+Accept: application/json
+
+### List GPG keys for a user
+## List GPG keys for a user
+GET https://api.github.com/users/{{username}}/gpg_keys
+Accept: application/json
+
+### List public email addresses for the authenticated user
+## List public email addresses for the authenticated user
+GET https://api.github.com/user/public_emails
+Accept: application/json
+
+### List public keys for a user
+## List public keys for a user
+GET https://api.github.com/users/{{username}}/keys
+Accept: application/json
+
+### List public SSH keys for the authenticated user
+## List public SSH keys for the authenticated user
+GET https://api.github.com/user/keys
+Accept: application/json
+
+### List social accounts for the authenticated user
+## List social accounts for the authenticated user
+GET https://api.github.com/user/social_accounts
+Accept: application/json
+
+### List social accounts for a user
+## List social accounts for a user
+GET https://api.github.com/users/{{username}}/social_accounts
+Accept: application/json
+
+### List SSH signing keys for the authenticated user
+## List SSH signing keys for the authenticated user
+GET https://api.github.com/user/ssh_signing_keys
+Accept: application/json
+
+### List SSH signing keys for a user
+## List SSH signing keys for a user
+GET https://api.github.com/users/{{username}}/ssh_signing_keys
+Accept: application/json
+
+### Set primary email visibility for the authenticated user
+## Set primary email visibility for the authenticated user
+PATCH https://api.github.com/user/email/visibility
+Content-Type: application/json
+Accept: application/json
+
+{
+ "visibility" : "private"
+}
+
+
+### Unblock a user
+## Unblock a user
+DELETE https://api.github.com/user/blocks/{{username}}
+Accept: application/json
+
+### Unfollow a user
+## Unfollow a user
+DELETE https://api.github.com/user/following/{{username}}
+Accept: application/json
+
+### Update the authenticated user
+## Update the authenticated user
+PATCH https://api.github.com/user
+Content-Type: application/json
+Accept: application/json
+
+{
+ "blog" : "https://github.com/blog",
+ "name" : "monalisa octocat"
+}
+
diff --git a/samples/client/github/jetbrains/http/client/README.md b/samples/client/github/jetbrains/http/client/README.md
new file mode 100644
index 000000000000..0c51f4fd3bca
--- /dev/null
+++ b/samples/client/github/jetbrains/http/client/README.md
@@ -0,0 +1,974 @@
+# GitHub v3 REST API - Jetbrains API Client
+
+## General API description
+
+GitHub's v3 REST API.
+
+* API basepath : [https://api.github.com](https://api.github.com)
+* Version : 1.1.4
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.github.com*, but will link to the `.http` file that contains the endpoint definition.
+There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ActionsApi* | [**actions/addCustomLabelsToSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/addcustomlabelstoselfhostedrunnerfororg) | **POST** /orgs/{org}/actions/runners/{runner_id}/labels | Add custom labels to a self-hosted runner for an organization
+*ActionsApi* | [**actions/addCustomLabelsToSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/addcustomlabelstoselfhostedrunnerforrepo) | **POST** /repos/{owner}/{repo}/actions/runners/{runner_id}/labels | Add custom labels to a self-hosted runner for a repository
+*ActionsApi* | [**actions/addSelectedRepoToOrgSecret**](Apis/ActionsApi.http#actions/addselectedrepotoorgsecret) | **PUT** /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id} | Add selected repository to an organization secret
+*ActionsApi* | [**actions/addSelectedRepoToOrgVariable**](Apis/ActionsApi.http#actions/addselectedrepotoorgvariable) | **PUT** /orgs/{org}/actions/variables/{name}/repositories/{repository_id} | Add selected repository to an organization variable
+*ActionsApi* | [**actions/approveWorkflowRun**](Apis/ActionsApi.http#actions/approveworkflowrun) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/approve | Approve a workflow run for a fork pull request
+*ActionsApi* | [**actions/cancelWorkflowRun**](Apis/ActionsApi.http#actions/cancelworkflowrun) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/cancel | Cancel a workflow run
+*ActionsApi* | [**actions/createEnvironmentVariable**](Apis/ActionsApi.http#actions/createenvironmentvariable) | **POST** /repositories/{repository_id}/environments/{environment_name}/variables | Create an environment variable
+*ActionsApi* | [**actions/createOrUpdateEnvironmentSecret**](Apis/ActionsApi.http#actions/createorupdateenvironmentsecret) | **PUT** /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} | Create or update an environment secret
+*ActionsApi* | [**actions/createOrUpdateOrgSecret**](Apis/ActionsApi.http#actions/createorupdateorgsecret) | **PUT** /orgs/{org}/actions/secrets/{secret_name} | Create or update an organization secret
+*ActionsApi* | [**actions/createOrUpdateRepoSecret**](Apis/ActionsApi.http#actions/createorupdatereposecret) | **PUT** /repos/{owner}/{repo}/actions/secrets/{secret_name} | Create or update a repository secret
+*ActionsApi* | [**actions/createOrgVariable**](Apis/ActionsApi.http#actions/createorgvariable) | **POST** /orgs/{org}/actions/variables | Create an organization variable
+*ActionsApi* | [**actions/createRegistrationTokenForOrg**](Apis/ActionsApi.http#actions/createregistrationtokenfororg) | **POST** /orgs/{org}/actions/runners/registration-token | Create a registration token for an organization
+*ActionsApi* | [**actions/createRegistrationTokenForRepo**](Apis/ActionsApi.http#actions/createregistrationtokenforrepo) | **POST** /repos/{owner}/{repo}/actions/runners/registration-token | Create a registration token for a repository
+*ActionsApi* | [**actions/createRemoveTokenForOrg**](Apis/ActionsApi.http#actions/createremovetokenfororg) | **POST** /orgs/{org}/actions/runners/remove-token | Create a remove token for an organization
+*ActionsApi* | [**actions/createRemoveTokenForRepo**](Apis/ActionsApi.http#actions/createremovetokenforrepo) | **POST** /repos/{owner}/{repo}/actions/runners/remove-token | Create a remove token for a repository
+*ActionsApi* | [**actions/createRepoVariable**](Apis/ActionsApi.http#actions/createrepovariable) | **POST** /repos/{owner}/{repo}/actions/variables | Create a repository variable
+*ActionsApi* | [**actions/createWorkflowDispatch**](Apis/ActionsApi.http#actions/createworkflowdispatch) | **POST** /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches | Create a workflow dispatch event
+*ActionsApi* | [**actions/deleteActionsCacheById**](Apis/ActionsApi.http#actions/deleteactionscachebyid) | **DELETE** /repos/{owner}/{repo}/actions/caches/{cache_id} | Delete a GitHub Actions cache for a repository (using a cache ID)
+*ActionsApi* | [**actions/deleteActionsCacheByKey**](Apis/ActionsApi.http#actions/deleteactionscachebykey) | **DELETE** /repos/{owner}/{repo}/actions/caches | Delete GitHub Actions caches for a repository (using a cache key)
+*ActionsApi* | [**actions/deleteArtifact**](Apis/ActionsApi.http#actions/deleteartifact) | **DELETE** /repos/{owner}/{repo}/actions/artifacts/{artifact_id} | Delete an artifact
+*ActionsApi* | [**actions/deleteEnvironmentSecret**](Apis/ActionsApi.http#actions/deleteenvironmentsecret) | **DELETE** /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} | Delete an environment secret
+*ActionsApi* | [**actions/deleteEnvironmentVariable**](Apis/ActionsApi.http#actions/deleteenvironmentvariable) | **DELETE** /repositories/{repository_id}/environments/{environment_name}/variables/{name} | Delete an environment variable
+*ActionsApi* | [**actions/deleteOrgSecret**](Apis/ActionsApi.http#actions/deleteorgsecret) | **DELETE** /orgs/{org}/actions/secrets/{secret_name} | Delete an organization secret
+*ActionsApi* | [**actions/deleteOrgVariable**](Apis/ActionsApi.http#actions/deleteorgvariable) | **DELETE** /orgs/{org}/actions/variables/{name} | Delete an organization variable
+*ActionsApi* | [**actions/deleteRepoSecret**](Apis/ActionsApi.http#actions/deletereposecret) | **DELETE** /repos/{owner}/{repo}/actions/secrets/{secret_name} | Delete a repository secret
+*ActionsApi* | [**actions/deleteRepoVariable**](Apis/ActionsApi.http#actions/deleterepovariable) | **DELETE** /repos/{owner}/{repo}/actions/variables/{name} | Delete a repository variable
+*ActionsApi* | [**actions/deleteSelfHostedRunnerFromOrg**](Apis/ActionsApi.http#actions/deleteselfhostedrunnerfromorg) | **DELETE** /orgs/{org}/actions/runners/{runner_id} | Delete a self-hosted runner from an organization
+*ActionsApi* | [**actions/deleteSelfHostedRunnerFromRepo**](Apis/ActionsApi.http#actions/deleteselfhostedrunnerfromrepo) | **DELETE** /repos/{owner}/{repo}/actions/runners/{runner_id} | Delete a self-hosted runner from a repository
+*ActionsApi* | [**actions/deleteWorkflowRun**](Apis/ActionsApi.http#actions/deleteworkflowrun) | **DELETE** /repos/{owner}/{repo}/actions/runs/{run_id} | Delete a workflow run
+*ActionsApi* | [**actions/deleteWorkflowRunLogs**](Apis/ActionsApi.http#actions/deleteworkflowrunlogs) | **DELETE** /repos/{owner}/{repo}/actions/runs/{run_id}/logs | Delete workflow run logs
+*ActionsApi* | [**actions/disableSelectedRepositoryGithubActionsOrganization**](Apis/ActionsApi.http#actions/disableselectedrepositorygithubactionsorganization) | **DELETE** /orgs/{org}/actions/permissions/repositories/{repository_id} | Disable a selected repository for GitHub Actions in an organization
+*ActionsApi* | [**actions/disableWorkflow**](Apis/ActionsApi.http#actions/disableworkflow) | **PUT** /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable | Disable a workflow
+*ActionsApi* | [**actions/downloadArtifact**](Apis/ActionsApi.http#actions/downloadartifact) | **GET** /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format} | Download an artifact
+*ActionsApi* | [**actions/downloadJobLogsForWorkflowRun**](Apis/ActionsApi.http#actions/downloadjoblogsforworkflowrun) | **GET** /repos/{owner}/{repo}/actions/jobs/{job_id}/logs | Download job logs for a workflow run
+*ActionsApi* | [**actions/downloadWorkflowRunAttemptLogs**](Apis/ActionsApi.http#actions/downloadworkflowrunattemptlogs) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs | Download workflow run attempt logs
+*ActionsApi* | [**actions/downloadWorkflowRunLogs**](Apis/ActionsApi.http#actions/downloadworkflowrunlogs) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/logs | Download workflow run logs
+*ActionsApi* | [**actions/enableSelectedRepositoryGithubActionsOrganization**](Apis/ActionsApi.http#actions/enableselectedrepositorygithubactionsorganization) | **PUT** /orgs/{org}/actions/permissions/repositories/{repository_id} | Enable a selected repository for GitHub Actions in an organization
+*ActionsApi* | [**actions/enableWorkflow**](Apis/ActionsApi.http#actions/enableworkflow) | **PUT** /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable | Enable a workflow
+*ActionsApi* | [**actions/forceCancelWorkflowRun**](Apis/ActionsApi.http#actions/forcecancelworkflowrun) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel | Force cancel a workflow run
+*ActionsApi* | [**actions/generateRunnerJitconfigForOrg**](Apis/ActionsApi.http#actions/generaterunnerjitconfigfororg) | **POST** /orgs/{org}/actions/runners/generate-jitconfig | Create configuration for a just-in-time runner for an organization
+*ActionsApi* | [**actions/generateRunnerJitconfigForRepo**](Apis/ActionsApi.http#actions/generaterunnerjitconfigforrepo) | **POST** /repos/{owner}/{repo}/actions/runners/generate-jitconfig | Create configuration for a just-in-time runner for a repository
+*ActionsApi* | [**actions/getActionsCacheList**](Apis/ActionsApi.http#actions/getactionscachelist) | **GET** /repos/{owner}/{repo}/actions/caches | List GitHub Actions caches for a repository
+*ActionsApi* | [**actions/getActionsCacheUsage**](Apis/ActionsApi.http#actions/getactionscacheusage) | **GET** /repos/{owner}/{repo}/actions/cache/usage | Get GitHub Actions cache usage for a repository
+*ActionsApi* | [**actions/getActionsCacheUsageByRepoForOrg**](Apis/ActionsApi.http#actions/getactionscacheusagebyrepofororg) | **GET** /orgs/{org}/actions/cache/usage-by-repository | List repositories with GitHub Actions cache usage for an organization
+*ActionsApi* | [**actions/getActionsCacheUsageForOrg**](Apis/ActionsApi.http#actions/getactionscacheusagefororg) | **GET** /orgs/{org}/actions/cache/usage | Get GitHub Actions cache usage for an organization
+*ActionsApi* | [**actions/getAllowedActionsOrganization**](Apis/ActionsApi.http#actions/getallowedactionsorganization) | **GET** /orgs/{org}/actions/permissions/selected-actions | Get allowed actions and reusable workflows for an organization
+*ActionsApi* | [**actions/getAllowedActionsRepository**](Apis/ActionsApi.http#actions/getallowedactionsrepository) | **GET** /repos/{owner}/{repo}/actions/permissions/selected-actions | Get allowed actions and reusable workflows for a repository
+*ActionsApi* | [**actions/getArtifact**](Apis/ActionsApi.http#actions/getartifact) | **GET** /repos/{owner}/{repo}/actions/artifacts/{artifact_id} | Get an artifact
+*ActionsApi* | [**actions/getCustomOidcSubClaimForRepo**](Apis/ActionsApi.http#actions/getcustomoidcsubclaimforrepo) | **GET** /repos/{owner}/{repo}/actions/oidc/customization/sub | Get the customization template for an OIDC subject claim for a repository
+*ActionsApi* | [**actions/getEnvironmentPublicKey**](Apis/ActionsApi.http#actions/getenvironmentpublickey) | **GET** /repositories/{repository_id}/environments/{environment_name}/secrets/public-key | Get an environment public key
+*ActionsApi* | [**actions/getEnvironmentSecret**](Apis/ActionsApi.http#actions/getenvironmentsecret) | **GET** /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} | Get an environment secret
+*ActionsApi* | [**actions/getEnvironmentVariable**](Apis/ActionsApi.http#actions/getenvironmentvariable) | **GET** /repositories/{repository_id}/environments/{environment_name}/variables/{name} | Get an environment variable
+*ActionsApi* | [**actions/getGithubActionsDefaultWorkflowPermissionsOrganization**](Apis/ActionsApi.http#actions/getgithubactionsdefaultworkflowpermissionsorganization) | **GET** /orgs/{org}/actions/permissions/workflow | Get default workflow permissions for an organization
+*ActionsApi* | [**actions/getGithubActionsDefaultWorkflowPermissionsRepository**](Apis/ActionsApi.http#actions/getgithubactionsdefaultworkflowpermissionsrepository) | **GET** /repos/{owner}/{repo}/actions/permissions/workflow | Get default workflow permissions for a repository
+*ActionsApi* | [**actions/getGithubActionsPermissionsOrganization**](Apis/ActionsApi.http#actions/getgithubactionspermissionsorganization) | **GET** /orgs/{org}/actions/permissions | Get GitHub Actions permissions for an organization
+*ActionsApi* | [**actions/getGithubActionsPermissionsRepository**](Apis/ActionsApi.http#actions/getgithubactionspermissionsrepository) | **GET** /repos/{owner}/{repo}/actions/permissions | Get GitHub Actions permissions for a repository
+*ActionsApi* | [**actions/getJobForWorkflowRun**](Apis/ActionsApi.http#actions/getjobforworkflowrun) | **GET** /repos/{owner}/{repo}/actions/jobs/{job_id} | Get a job for a workflow run
+*ActionsApi* | [**actions/getOrgPublicKey**](Apis/ActionsApi.http#actions/getorgpublickey) | **GET** /orgs/{org}/actions/secrets/public-key | Get an organization public key
+*ActionsApi* | [**actions/getOrgSecret**](Apis/ActionsApi.http#actions/getorgsecret) | **GET** /orgs/{org}/actions/secrets/{secret_name} | Get an organization secret
+*ActionsApi* | [**actions/getOrgVariable**](Apis/ActionsApi.http#actions/getorgvariable) | **GET** /orgs/{org}/actions/variables/{name} | Get an organization variable
+*ActionsApi* | [**actions/getPendingDeploymentsForRun**](Apis/ActionsApi.http#actions/getpendingdeploymentsforrun) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments | Get pending deployments for a workflow run
+*ActionsApi* | [**actions/getRepoPublicKey**](Apis/ActionsApi.http#actions/getrepopublickey) | **GET** /repos/{owner}/{repo}/actions/secrets/public-key | Get a repository public key
+*ActionsApi* | [**actions/getRepoSecret**](Apis/ActionsApi.http#actions/getreposecret) | **GET** /repos/{owner}/{repo}/actions/secrets/{secret_name} | Get a repository secret
+*ActionsApi* | [**actions/getRepoVariable**](Apis/ActionsApi.http#actions/getrepovariable) | **GET** /repos/{owner}/{repo}/actions/variables/{name} | Get a repository variable
+*ActionsApi* | [**actions/getReviewsForRun**](Apis/ActionsApi.http#actions/getreviewsforrun) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/approvals | Get the review history for a workflow run
+*ActionsApi* | [**actions/getSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/getselfhostedrunnerfororg) | **GET** /orgs/{org}/actions/runners/{runner_id} | Get a self-hosted runner for an organization
+*ActionsApi* | [**actions/getSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/getselfhostedrunnerforrepo) | **GET** /repos/{owner}/{repo}/actions/runners/{runner_id} | Get a self-hosted runner for a repository
+*ActionsApi* | [**actions/getWorkflow**](Apis/ActionsApi.http#actions/getworkflow) | **GET** /repos/{owner}/{repo}/actions/workflows/{workflow_id} | Get a workflow
+*ActionsApi* | [**actions/getWorkflowAccessToRepository**](Apis/ActionsApi.http#actions/getworkflowaccesstorepository) | **GET** /repos/{owner}/{repo}/actions/permissions/access | Get the level of access for workflows outside of the repository
+*ActionsApi* | [**actions/getWorkflowRun**](Apis/ActionsApi.http#actions/getworkflowrun) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id} | Get a workflow run
+*ActionsApi* | [**actions/getWorkflowRunAttempt**](Apis/ActionsApi.http#actions/getworkflowrunattempt) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number} | Get a workflow run attempt
+*ActionsApi* | [**actions/getWorkflowRunUsage**](Apis/ActionsApi.http#actions/getworkflowrunusage) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/timing | Get workflow run usage
+*ActionsApi* | [**actions/getWorkflowUsage**](Apis/ActionsApi.http#actions/getworkflowusage) | **GET** /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing | Get workflow usage
+*ActionsApi* | [**actions/listArtifactsForRepo**](Apis/ActionsApi.http#actions/listartifactsforrepo) | **GET** /repos/{owner}/{repo}/actions/artifacts | List artifacts for a repository
+*ActionsApi* | [**actions/listEnvironmentSecrets**](Apis/ActionsApi.http#actions/listenvironmentsecrets) | **GET** /repositories/{repository_id}/environments/{environment_name}/secrets | List environment secrets
+*ActionsApi* | [**actions/listEnvironmentVariables**](Apis/ActionsApi.http#actions/listenvironmentvariables) | **GET** /repositories/{repository_id}/environments/{environment_name}/variables | List environment variables
+*ActionsApi* | [**actions/listJobsForWorkflowRun**](Apis/ActionsApi.http#actions/listjobsforworkflowrun) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/jobs | List jobs for a workflow run
+*ActionsApi* | [**actions/listJobsForWorkflowRunAttempt**](Apis/ActionsApi.http#actions/listjobsforworkflowrunattempt) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs | List jobs for a workflow run attempt
+*ActionsApi* | [**actions/listLabelsForSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/listlabelsforselfhostedrunnerfororg) | **GET** /orgs/{org}/actions/runners/{runner_id}/labels | List labels for a self-hosted runner for an organization
+*ActionsApi* | [**actions/listLabelsForSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/listlabelsforselfhostedrunnerforrepo) | **GET** /repos/{owner}/{repo}/actions/runners/{runner_id}/labels | List labels for a self-hosted runner for a repository
+*ActionsApi* | [**actions/listOrgSecrets**](Apis/ActionsApi.http#actions/listorgsecrets) | **GET** /orgs/{org}/actions/secrets | List organization secrets
+*ActionsApi* | [**actions/listOrgVariables**](Apis/ActionsApi.http#actions/listorgvariables) | **GET** /orgs/{org}/actions/variables | List organization variables
+*ActionsApi* | [**actions/listRepoOrganizationSecrets**](Apis/ActionsApi.http#actions/listrepoorganizationsecrets) | **GET** /repos/{owner}/{repo}/actions/organization-secrets | List repository organization secrets
+*ActionsApi* | [**actions/listRepoOrganizationVariables**](Apis/ActionsApi.http#actions/listrepoorganizationvariables) | **GET** /repos/{owner}/{repo}/actions/organization-variables | List repository organization variables
+*ActionsApi* | [**actions/listRepoSecrets**](Apis/ActionsApi.http#actions/listreposecrets) | **GET** /repos/{owner}/{repo}/actions/secrets | List repository secrets
+*ActionsApi* | [**actions/listRepoVariables**](Apis/ActionsApi.http#actions/listrepovariables) | **GET** /repos/{owner}/{repo}/actions/variables | List repository variables
+*ActionsApi* | [**actions/listRepoWorkflows**](Apis/ActionsApi.http#actions/listrepoworkflows) | **GET** /repos/{owner}/{repo}/actions/workflows | List repository workflows
+*ActionsApi* | [**actions/listRunnerApplicationsForOrg**](Apis/ActionsApi.http#actions/listrunnerapplicationsfororg) | **GET** /orgs/{org}/actions/runners/downloads | List runner applications for an organization
+*ActionsApi* | [**actions/listRunnerApplicationsForRepo**](Apis/ActionsApi.http#actions/listrunnerapplicationsforrepo) | **GET** /repos/{owner}/{repo}/actions/runners/downloads | List runner applications for a repository
+*ActionsApi* | [**actions/listSelectedReposForOrgSecret**](Apis/ActionsApi.http#actions/listselectedreposfororgsecret) | **GET** /orgs/{org}/actions/secrets/{secret_name}/repositories | List selected repositories for an organization secret
+*ActionsApi* | [**actions/listSelectedReposForOrgVariable**](Apis/ActionsApi.http#actions/listselectedreposfororgvariable) | **GET** /orgs/{org}/actions/variables/{name}/repositories | List selected repositories for an organization variable
+*ActionsApi* | [**actions/listSelectedRepositoriesEnabledGithubActionsOrganization**](Apis/ActionsApi.http#actions/listselectedrepositoriesenabledgithubactionsorganization) | **GET** /orgs/{org}/actions/permissions/repositories | List selected repositories enabled for GitHub Actions in an organization
+*ActionsApi* | [**actions/listSelfHostedRunnersForOrg**](Apis/ActionsApi.http#actions/listselfhostedrunnersfororg) | **GET** /orgs/{org}/actions/runners | List self-hosted runners for an organization
+*ActionsApi* | [**actions/listSelfHostedRunnersForRepo**](Apis/ActionsApi.http#actions/listselfhostedrunnersforrepo) | **GET** /repos/{owner}/{repo}/actions/runners | List self-hosted runners for a repository
+*ActionsApi* | [**actions/listWorkflowRunArtifacts**](Apis/ActionsApi.http#actions/listworkflowrunartifacts) | **GET** /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts | List workflow run artifacts
+*ActionsApi* | [**actions/listWorkflowRuns**](Apis/ActionsApi.http#actions/listworkflowruns) | **GET** /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs | List workflow runs for a workflow
+*ActionsApi* | [**actions/listWorkflowRunsForRepo**](Apis/ActionsApi.http#actions/listworkflowrunsforrepo) | **GET** /repos/{owner}/{repo}/actions/runs | List workflow runs for a repository
+*ActionsApi* | [**actions/reRunJobForWorkflowRun**](Apis/ActionsApi.http#actions/rerunjobforworkflowrun) | **POST** /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun | Re-run a job from a workflow run
+*ActionsApi* | [**actions/reRunWorkflow**](Apis/ActionsApi.http#actions/rerunworkflow) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/rerun | Re-run a workflow
+*ActionsApi* | [**actions/reRunWorkflowFailedJobs**](Apis/ActionsApi.http#actions/rerunworkflowfailedjobs) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs | Re-run failed jobs from a workflow run
+*ActionsApi* | [**actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/removeallcustomlabelsfromselfhostedrunnerfororg) | **DELETE** /orgs/{org}/actions/runners/{runner_id}/labels | Remove all custom labels from a self-hosted runner for an organization
+*ActionsApi* | [**actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/removeallcustomlabelsfromselfhostedrunnerforrepo) | **DELETE** /repos/{owner}/{repo}/actions/runners/{runner_id}/labels | Remove all custom labels from a self-hosted runner for a repository
+*ActionsApi* | [**actions/removeCustomLabelFromSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/removecustomlabelfromselfhostedrunnerfororg) | **DELETE** /orgs/{org}/actions/runners/{runner_id}/labels/{name} | Remove a custom label from a self-hosted runner for an organization
+*ActionsApi* | [**actions/removeCustomLabelFromSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/removecustomlabelfromselfhostedrunnerforrepo) | **DELETE** /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name} | Remove a custom label from a self-hosted runner for a repository
+*ActionsApi* | [**actions/removeSelectedRepoFromOrgSecret**](Apis/ActionsApi.http#actions/removeselectedrepofromorgsecret) | **DELETE** /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id} | Remove selected repository from an organization secret
+*ActionsApi* | [**actions/removeSelectedRepoFromOrgVariable**](Apis/ActionsApi.http#actions/removeselectedrepofromorgvariable) | **DELETE** /orgs/{org}/actions/variables/{name}/repositories/{repository_id} | Remove selected repository from an organization variable
+*ActionsApi* | [**actions/reviewCustomGatesForRun**](Apis/ActionsApi.http#actions/reviewcustomgatesforrun) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule | Review custom deployment protection rules for a workflow run
+*ActionsApi* | [**actions/reviewPendingDeploymentsForRun**](Apis/ActionsApi.http#actions/reviewpendingdeploymentsforrun) | **POST** /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments | Review pending deployments for a workflow run
+*ActionsApi* | [**actions/setAllowedActionsOrganization**](Apis/ActionsApi.http#actions/setallowedactionsorganization) | **PUT** /orgs/{org}/actions/permissions/selected-actions | Set allowed actions and reusable workflows for an organization
+*ActionsApi* | [**actions/setAllowedActionsRepository**](Apis/ActionsApi.http#actions/setallowedactionsrepository) | **PUT** /repos/{owner}/{repo}/actions/permissions/selected-actions | Set allowed actions and reusable workflows for a repository
+*ActionsApi* | [**actions/setCustomLabelsForSelfHostedRunnerForOrg**](Apis/ActionsApi.http#actions/setcustomlabelsforselfhostedrunnerfororg) | **PUT** /orgs/{org}/actions/runners/{runner_id}/labels | Set custom labels for a self-hosted runner for an organization
+*ActionsApi* | [**actions/setCustomLabelsForSelfHostedRunnerForRepo**](Apis/ActionsApi.http#actions/setcustomlabelsforselfhostedrunnerforrepo) | **PUT** /repos/{owner}/{repo}/actions/runners/{runner_id}/labels | Set custom labels for a self-hosted runner for a repository
+*ActionsApi* | [**actions/setCustomOidcSubClaimForRepo**](Apis/ActionsApi.http#actions/setcustomoidcsubclaimforrepo) | **PUT** /repos/{owner}/{repo}/actions/oidc/customization/sub | Set the customization template for an OIDC subject claim for a repository
+*ActionsApi* | [**actions/setGithubActionsDefaultWorkflowPermissionsOrganization**](Apis/ActionsApi.http#actions/setgithubactionsdefaultworkflowpermissionsorganization) | **PUT** /orgs/{org}/actions/permissions/workflow | Set default workflow permissions for an organization
+*ActionsApi* | [**actions/setGithubActionsDefaultWorkflowPermissionsRepository**](Apis/ActionsApi.http#actions/setgithubactionsdefaultworkflowpermissionsrepository) | **PUT** /repos/{owner}/{repo}/actions/permissions/workflow | Set default workflow permissions for a repository
+*ActionsApi* | [**actions/setGithubActionsPermissionsOrganization**](Apis/ActionsApi.http#actions/setgithubactionspermissionsorganization) | **PUT** /orgs/{org}/actions/permissions | Set GitHub Actions permissions for an organization
+*ActionsApi* | [**actions/setGithubActionsPermissionsRepository**](Apis/ActionsApi.http#actions/setgithubactionspermissionsrepository) | **PUT** /repos/{owner}/{repo}/actions/permissions | Set GitHub Actions permissions for a repository
+*ActionsApi* | [**actions/setSelectedReposForOrgSecret**](Apis/ActionsApi.http#actions/setselectedreposfororgsecret) | **PUT** /orgs/{org}/actions/secrets/{secret_name}/repositories | Set selected repositories for an organization secret
+*ActionsApi* | [**actions/setSelectedReposForOrgVariable**](Apis/ActionsApi.http#actions/setselectedreposfororgvariable) | **PUT** /orgs/{org}/actions/variables/{name}/repositories | Set selected repositories for an organization variable
+*ActionsApi* | [**actions/setSelectedRepositoriesEnabledGithubActionsOrganization**](Apis/ActionsApi.http#actions/setselectedrepositoriesenabledgithubactionsorganization) | **PUT** /orgs/{org}/actions/permissions/repositories | Set selected repositories enabled for GitHub Actions in an organization
+*ActionsApi* | [**actions/setWorkflowAccessToRepository**](Apis/ActionsApi.http#actions/setworkflowaccesstorepository) | **PUT** /repos/{owner}/{repo}/actions/permissions/access | Set the level of access for workflows outside of the repository
+*ActionsApi* | [**actions/updateEnvironmentVariable**](Apis/ActionsApi.http#actions/updateenvironmentvariable) | **PATCH** /repositories/{repository_id}/environments/{environment_name}/variables/{name} | Update an environment variable
+*ActionsApi* | [**actions/updateOrgVariable**](Apis/ActionsApi.http#actions/updateorgvariable) | **PATCH** /orgs/{org}/actions/variables/{name} | Update an organization variable
+*ActionsApi* | [**actions/updateRepoVariable**](Apis/ActionsApi.http#actions/updaterepovariable) | **PATCH** /repos/{owner}/{repo}/actions/variables/{name} | Update a repository variable
+*ActivityApi* | [**activity/checkRepoIsStarredByAuthenticatedUser**](Apis/ActivityApi.http#activity/checkrepoisstarredbyauthenticateduser) | **GET** /user/starred/{owner}/{repo} | Check if a repository is starred by the authenticated user
+*ActivityApi* | [**activity/deleteRepoSubscription**](Apis/ActivityApi.http#activity/deletereposubscription) | **DELETE** /repos/{owner}/{repo}/subscription | Delete a repository subscription
+*ActivityApi* | [**activity/deleteThreadSubscription**](Apis/ActivityApi.http#activity/deletethreadsubscription) | **DELETE** /notifications/threads/{thread_id}/subscription | Delete a thread subscription
+*ActivityApi* | [**activity/getFeeds**](Apis/ActivityApi.http#activity/getfeeds) | **GET** /feeds | Get feeds
+*ActivityApi* | [**activity/getRepoSubscription**](Apis/ActivityApi.http#activity/getreposubscription) | **GET** /repos/{owner}/{repo}/subscription | Get a repository subscription
+*ActivityApi* | [**activity/getThread**](Apis/ActivityApi.http#activity/getthread) | **GET** /notifications/threads/{thread_id} | Get a thread
+*ActivityApi* | [**activity/getThreadSubscriptionForAuthenticatedUser**](Apis/ActivityApi.http#activity/getthreadsubscriptionforauthenticateduser) | **GET** /notifications/threads/{thread_id}/subscription | Get a thread subscription for the authenticated user
+*ActivityApi* | [**activity/listEventsForAuthenticatedUser**](Apis/ActivityApi.http#activity/listeventsforauthenticateduser) | **GET** /users/{username}/events | List events for the authenticated user
+*ActivityApi* | [**activity/listNotificationsForAuthenticatedUser**](Apis/ActivityApi.http#activity/listnotificationsforauthenticateduser) | **GET** /notifications | List notifications for the authenticated user
+*ActivityApi* | [**activity/listOrgEventsForAuthenticatedUser**](Apis/ActivityApi.http#activity/listorgeventsforauthenticateduser) | **GET** /users/{username}/events/orgs/{org} | List organization events for the authenticated user
+*ActivityApi* | [**activity/listPublicEvents**](Apis/ActivityApi.http#activity/listpublicevents) | **GET** /events | List public events
+*ActivityApi* | [**activity/listPublicEventsForRepoNetwork**](Apis/ActivityApi.http#activity/listpubliceventsforreponetwork) | **GET** /networks/{owner}/{repo}/events | List public events for a network of repositories
+*ActivityApi* | [**activity/listPublicEventsForUser**](Apis/ActivityApi.http#activity/listpubliceventsforuser) | **GET** /users/{username}/events/public | List public events for a user
+*ActivityApi* | [**activity/listPublicOrgEvents**](Apis/ActivityApi.http#activity/listpublicorgevents) | **GET** /orgs/{org}/events | List public organization events
+*ActivityApi* | [**activity/listReceivedEventsForUser**](Apis/ActivityApi.http#activity/listreceivedeventsforuser) | **GET** /users/{username}/received_events | List events received by the authenticated user
+*ActivityApi* | [**activity/listReceivedPublicEventsForUser**](Apis/ActivityApi.http#activity/listreceivedpubliceventsforuser) | **GET** /users/{username}/received_events/public | List public events received by a user
+*ActivityApi* | [**activity/listRepoEvents**](Apis/ActivityApi.http#activity/listrepoevents) | **GET** /repos/{owner}/{repo}/events | List repository events
+*ActivityApi* | [**activity/listRepoNotificationsForAuthenticatedUser**](Apis/ActivityApi.http#activity/listreponotificationsforauthenticateduser) | **GET** /repos/{owner}/{repo}/notifications | List repository notifications for the authenticated user
+*ActivityApi* | [**activity/listReposStarredByAuthenticatedUser**](Apis/ActivityApi.http#activity/listreposstarredbyauthenticateduser) | **GET** /user/starred | List repositories starred by the authenticated user
+*ActivityApi* | [**activity/listReposStarredByUser**](Apis/ActivityApi.http#activity/listreposstarredbyuser) | **GET** /users/{username}/starred | List repositories starred by a user
+*ActivityApi* | [**activity/listReposWatchedByUser**](Apis/ActivityApi.http#activity/listreposwatchedbyuser) | **GET** /users/{username}/subscriptions | List repositories watched by a user
+*ActivityApi* | [**activity/listStargazersForRepo**](Apis/ActivityApi.http#activity/liststargazersforrepo) | **GET** /repos/{owner}/{repo}/stargazers | List stargazers
+*ActivityApi* | [**activity/listWatchedReposForAuthenticatedUser**](Apis/ActivityApi.http#activity/listwatchedreposforauthenticateduser) | **GET** /user/subscriptions | List repositories watched by the authenticated user
+*ActivityApi* | [**activity/listWatchersForRepo**](Apis/ActivityApi.http#activity/listwatchersforrepo) | **GET** /repos/{owner}/{repo}/subscribers | List watchers
+*ActivityApi* | [**activity/markNotificationsAsRead**](Apis/ActivityApi.http#activity/marknotificationsasread) | **PUT** /notifications | Mark notifications as read
+*ActivityApi* | [**activity/markRepoNotificationsAsRead**](Apis/ActivityApi.http#activity/markreponotificationsasread) | **PUT** /repos/{owner}/{repo}/notifications | Mark repository notifications as read
+*ActivityApi* | [**activity/markThreadAsDone**](Apis/ActivityApi.http#activity/markthreadasdone) | **DELETE** /notifications/threads/{thread_id} | Mark a thread as done
+*ActivityApi* | [**activity/markThreadAsRead**](Apis/ActivityApi.http#activity/markthreadasread) | **PATCH** /notifications/threads/{thread_id} | Mark a thread as read
+*ActivityApi* | [**activity/setRepoSubscription**](Apis/ActivityApi.http#activity/setreposubscription) | **PUT** /repos/{owner}/{repo}/subscription | Set a repository subscription
+*ActivityApi* | [**activity/setThreadSubscription**](Apis/ActivityApi.http#activity/setthreadsubscription) | **PUT** /notifications/threads/{thread_id}/subscription | Set a thread subscription
+*ActivityApi* | [**activity/starRepoForAuthenticatedUser**](Apis/ActivityApi.http#activity/starrepoforauthenticateduser) | **PUT** /user/starred/{owner}/{repo} | Star a repository for the authenticated user
+*ActivityApi* | [**activity/unstarRepoForAuthenticatedUser**](Apis/ActivityApi.http#activity/unstarrepoforauthenticateduser) | **DELETE** /user/starred/{owner}/{repo} | Unstar a repository for the authenticated user
+*AppsApi* | [**apps/addRepoToInstallationForAuthenticatedUser**](Apis/AppsApi.http#apps/addrepotoinstallationforauthenticateduser) | **PUT** /user/installations/{installation_id}/repositories/{repository_id} | Add a repository to an app installation
+*AppsApi* | [**apps/checkToken**](Apis/AppsApi.http#apps/checktoken) | **POST** /applications/{client_id}/token | Check a token
+*AppsApi* | [**apps/createFromManifest**](Apis/AppsApi.http#apps/createfrommanifest) | **POST** /app-manifests/{code}/conversions | Create a GitHub App from a manifest
+*AppsApi* | [**apps/createInstallationAccessToken**](Apis/AppsApi.http#apps/createinstallationaccesstoken) | **POST** /app/installations/{installation_id}/access_tokens | Create an installation access token for an app
+*AppsApi* | [**apps/deleteAuthorization**](Apis/AppsApi.http#apps/deleteauthorization) | **DELETE** /applications/{client_id}/grant | Delete an app authorization
+*AppsApi* | [**apps/deleteInstallation**](Apis/AppsApi.http#apps/deleteinstallation) | **DELETE** /app/installations/{installation_id} | Delete an installation for the authenticated app
+*AppsApi* | [**apps/deleteToken**](Apis/AppsApi.http#apps/deletetoken) | **DELETE** /applications/{client_id}/token | Delete an app token
+*AppsApi* | [**apps/getAuthenticated**](Apis/AppsApi.http#apps/getauthenticated) | **GET** /app | Get the authenticated app
+*AppsApi* | [**apps/getBySlug**](Apis/AppsApi.http#apps/getbyslug) | **GET** /apps/{app_slug} | Get an app
+*AppsApi* | [**apps/getInstallation**](Apis/AppsApi.http#apps/getinstallation) | **GET** /app/installations/{installation_id} | Get an installation for the authenticated app
+*AppsApi* | [**apps/getOrgInstallation**](Apis/AppsApi.http#apps/getorginstallation) | **GET** /orgs/{org}/installation | Get an organization installation for the authenticated app
+*AppsApi* | [**apps/getRepoInstallation**](Apis/AppsApi.http#apps/getrepoinstallation) | **GET** /repos/{owner}/{repo}/installation | Get a repository installation for the authenticated app
+*AppsApi* | [**apps/getSubscriptionPlanForAccount**](Apis/AppsApi.http#apps/getsubscriptionplanforaccount) | **GET** /marketplace_listing/accounts/{account_id} | Get a subscription plan for an account
+*AppsApi* | [**apps/getSubscriptionPlanForAccountStubbed**](Apis/AppsApi.http#apps/getsubscriptionplanforaccountstubbed) | **GET** /marketplace_listing/stubbed/accounts/{account_id} | Get a subscription plan for an account (stubbed)
+*AppsApi* | [**apps/getUserInstallation**](Apis/AppsApi.http#apps/getuserinstallation) | **GET** /users/{username}/installation | Get a user installation for the authenticated app
+*AppsApi* | [**apps/getWebhookConfigForApp**](Apis/AppsApi.http#apps/getwebhookconfigforapp) | **GET** /app/hook/config | Get a webhook configuration for an app
+*AppsApi* | [**apps/getWebhookDelivery**](Apis/AppsApi.http#apps/getwebhookdelivery) | **GET** /app/hook/deliveries/{delivery_id} | Get a delivery for an app webhook
+*AppsApi* | [**apps/listAccountsForPlan**](Apis/AppsApi.http#apps/listaccountsforplan) | **GET** /marketplace_listing/plans/{plan_id}/accounts | List accounts for a plan
+*AppsApi* | [**apps/listAccountsForPlanStubbed**](Apis/AppsApi.http#apps/listaccountsforplanstubbed) | **GET** /marketplace_listing/stubbed/plans/{plan_id}/accounts | List accounts for a plan (stubbed)
+*AppsApi* | [**apps/listInstallationReposForAuthenticatedUser**](Apis/AppsApi.http#apps/listinstallationreposforauthenticateduser) | **GET** /user/installations/{installation_id}/repositories | List repositories accessible to the user access token
+*AppsApi* | [**apps/listInstallationRequestsForAuthenticatedApp**](Apis/AppsApi.http#apps/listinstallationrequestsforauthenticatedapp) | **GET** /app/installation-requests | List installation requests for the authenticated app
+*AppsApi* | [**apps/listInstallations**](Apis/AppsApi.http#apps/listinstallations) | **GET** /app/installations | List installations for the authenticated app
+*AppsApi* | [**apps/listInstallationsForAuthenticatedUser**](Apis/AppsApi.http#apps/listinstallationsforauthenticateduser) | **GET** /user/installations | List app installations accessible to the user access token
+*AppsApi* | [**apps/listPlans**](Apis/AppsApi.http#apps/listplans) | **GET** /marketplace_listing/plans | List plans
+*AppsApi* | [**apps/listPlansStubbed**](Apis/AppsApi.http#apps/listplansstubbed) | **GET** /marketplace_listing/stubbed/plans | List plans (stubbed)
+*AppsApi* | [**apps/listReposAccessibleToInstallation**](Apis/AppsApi.http#apps/listreposaccessibletoinstallation) | **GET** /installation/repositories | List repositories accessible to the app installation
+*AppsApi* | [**apps/listSubscriptionsForAuthenticatedUser**](Apis/AppsApi.http#apps/listsubscriptionsforauthenticateduser) | **GET** /user/marketplace_purchases | List subscriptions for the authenticated user
+*AppsApi* | [**apps/listSubscriptionsForAuthenticatedUserStubbed**](Apis/AppsApi.http#apps/listsubscriptionsforauthenticateduserstubbed) | **GET** /user/marketplace_purchases/stubbed | List subscriptions for the authenticated user (stubbed)
+*AppsApi* | [**apps/listWebhookDeliveries**](Apis/AppsApi.http#apps/listwebhookdeliveries) | **GET** /app/hook/deliveries | List deliveries for an app webhook
+*AppsApi* | [**apps/redeliverWebhookDelivery**](Apis/AppsApi.http#apps/redeliverwebhookdelivery) | **POST** /app/hook/deliveries/{delivery_id}/attempts | Redeliver a delivery for an app webhook
+*AppsApi* | [**apps/removeRepoFromInstallationForAuthenticatedUser**](Apis/AppsApi.http#apps/removerepofrominstallationforauthenticateduser) | **DELETE** /user/installations/{installation_id}/repositories/{repository_id} | Remove a repository from an app installation
+*AppsApi* | [**apps/resetToken**](Apis/AppsApi.http#apps/resettoken) | **PATCH** /applications/{client_id}/token | Reset a token
+*AppsApi* | [**apps/revokeInstallationAccessToken**](Apis/AppsApi.http#apps/revokeinstallationaccesstoken) | **DELETE** /installation/token | Revoke an installation access token
+*AppsApi* | [**apps/scopeToken**](Apis/AppsApi.http#apps/scopetoken) | **POST** /applications/{client_id}/token/scoped | Create a scoped access token
+*AppsApi* | [**apps/suspendInstallation**](Apis/AppsApi.http#apps/suspendinstallation) | **PUT** /app/installations/{installation_id}/suspended | Suspend an app installation
+*AppsApi* | [**apps/unsuspendInstallation**](Apis/AppsApi.http#apps/unsuspendinstallation) | **DELETE** /app/installations/{installation_id}/suspended | Unsuspend an app installation
+*AppsApi* | [**apps/updateWebhookConfigForApp**](Apis/AppsApi.http#apps/updatewebhookconfigforapp) | **PATCH** /app/hook/config | Update a webhook configuration for an app
+*BillingApi* | [**billing/getGithubActionsBillingOrg**](Apis/BillingApi.http#billing/getgithubactionsbillingorg) | **GET** /orgs/{org}/settings/billing/actions | Get GitHub Actions billing for an organization
+*BillingApi* | [**billing/getGithubActionsBillingUser**](Apis/BillingApi.http#billing/getgithubactionsbillinguser) | **GET** /users/{username}/settings/billing/actions | Get GitHub Actions billing for a user
+*BillingApi* | [**billing/getGithubPackagesBillingOrg**](Apis/BillingApi.http#billing/getgithubpackagesbillingorg) | **GET** /orgs/{org}/settings/billing/packages | Get GitHub Packages billing for an organization
+*BillingApi* | [**billing/getGithubPackagesBillingUser**](Apis/BillingApi.http#billing/getgithubpackagesbillinguser) | **GET** /users/{username}/settings/billing/packages | Get GitHub Packages billing for a user
+*BillingApi* | [**billing/getSharedStorageBillingOrg**](Apis/BillingApi.http#billing/getsharedstoragebillingorg) | **GET** /orgs/{org}/settings/billing/shared-storage | Get shared storage billing for an organization
+*BillingApi* | [**billing/getSharedStorageBillingUser**](Apis/BillingApi.http#billing/getsharedstoragebillinguser) | **GET** /users/{username}/settings/billing/shared-storage | Get shared storage billing for a user
+*ChecksApi* | [**checks/create**](Apis/ChecksApi.http#checks/create) | **POST** /repos/{owner}/{repo}/check-runs | Create a check run
+*ChecksApi* | [**checks/createSuite**](Apis/ChecksApi.http#checks/createsuite) | **POST** /repos/{owner}/{repo}/check-suites | Create a check suite
+*ChecksApi* | [**checks/get**](Apis/ChecksApi.http#checks/get) | **GET** /repos/{owner}/{repo}/check-runs/{check_run_id} | Get a check run
+*ChecksApi* | [**checks/getSuite**](Apis/ChecksApi.http#checks/getsuite) | **GET** /repos/{owner}/{repo}/check-suites/{check_suite_id} | Get a check suite
+*ChecksApi* | [**checks/listAnnotations**](Apis/ChecksApi.http#checks/listannotations) | **GET** /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations | List check run annotations
+*ChecksApi* | [**checks/listForRef**](Apis/ChecksApi.http#checks/listforref) | **GET** /repos/{owner}/{repo}/commits/{ref}/check-runs | List check runs for a Git reference
+*ChecksApi* | [**checks/listForSuite**](Apis/ChecksApi.http#checks/listforsuite) | **GET** /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs | List check runs in a check suite
+*ChecksApi* | [**checks/listSuitesForRef**](Apis/ChecksApi.http#checks/listsuitesforref) | **GET** /repos/{owner}/{repo}/commits/{ref}/check-suites | List check suites for a Git reference
+*ChecksApi* | [**checks/rerequestRun**](Apis/ChecksApi.http#checks/rerequestrun) | **POST** /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest | Rerequest a check run
+*ChecksApi* | [**checks/rerequestSuite**](Apis/ChecksApi.http#checks/rerequestsuite) | **POST** /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest | Rerequest a check suite
+*ChecksApi* | [**checks/setSuitesPreferences**](Apis/ChecksApi.http#checks/setsuitespreferences) | **PATCH** /repos/{owner}/{repo}/check-suites/preferences | Update repository preferences for check suites
+*ChecksApi* | [**checks/update**](Apis/ChecksApi.http#checks/update) | **PATCH** /repos/{owner}/{repo}/check-runs/{check_run_id} | Update a check run
+*ClassroomApi* | [**classroom/getAClassroom**](Apis/ClassroomApi.http#classroom/getaclassroom) | **GET** /classrooms/{classroom_id} | Get a classroom
+*ClassroomApi* | [**classroom/getAnAssignment**](Apis/ClassroomApi.http#classroom/getanassignment) | **GET** /assignments/{assignment_id} | Get an assignment
+*ClassroomApi* | [**classroom/getAssignmentGrades**](Apis/ClassroomApi.http#classroom/getassignmentgrades) | **GET** /assignments/{assignment_id}/grades | Get assignment grades
+*ClassroomApi* | [**classroom/listAcceptedAssigmentsForAnAssignment**](Apis/ClassroomApi.http#classroom/listacceptedassigmentsforanassignment) | **GET** /assignments/{assignment_id}/accepted_assignments | List accepted assignments for an assignment
+*ClassroomApi* | [**classroom/listAssignmentsForAClassroom**](Apis/ClassroomApi.http#classroom/listassignmentsforaclassroom) | **GET** /classrooms/{classroom_id}/assignments | List assignments for a classroom
+*ClassroomApi* | [**classroom/listClassrooms**](Apis/ClassroomApi.http#classroom/listclassrooms) | **GET** /classrooms | List classrooms
+*CodeScanningApi* | [**codeScanning/deleteAnalysis**](Apis/CodeScanningApi.http#codescanning/deleteanalysis) | **DELETE** /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id} | Delete a code scanning analysis from a repository
+*CodeScanningApi* | [**codeScanning/getAlert**](Apis/CodeScanningApi.http#codescanning/getalert) | **GET** /repos/{owner}/{repo}/code-scanning/alerts/{alert_number} | Get a code scanning alert
+*CodeScanningApi* | [**codeScanning/getAnalysis**](Apis/CodeScanningApi.http#codescanning/getanalysis) | **GET** /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id} | Get a code scanning analysis for a repository
+*CodeScanningApi* | [**codeScanning/getCodeqlDatabase**](Apis/CodeScanningApi.http#codescanning/getcodeqldatabase) | **GET** /repos/{owner}/{repo}/code-scanning/codeql/databases/{language} | Get a CodeQL database for a repository
+*CodeScanningApi* | [**codeScanning/getDefaultSetup**](Apis/CodeScanningApi.http#codescanning/getdefaultsetup) | **GET** /repos/{owner}/{repo}/code-scanning/default-setup | Get a code scanning default setup configuration
+*CodeScanningApi* | [**codeScanning/getSarif**](Apis/CodeScanningApi.http#codescanning/getsarif) | **GET** /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id} | Get information about a SARIF upload
+*CodeScanningApi* | [**codeScanning/listAlertInstances**](Apis/CodeScanningApi.http#codescanning/listalertinstances) | **GET** /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances | List instances of a code scanning alert
+*CodeScanningApi* | [**codeScanning/listAlertsForOrg**](Apis/CodeScanningApi.http#codescanning/listalertsfororg) | **GET** /orgs/{org}/code-scanning/alerts | List code scanning alerts for an organization
+*CodeScanningApi* | [**codeScanning/listAlertsForRepo**](Apis/CodeScanningApi.http#codescanning/listalertsforrepo) | **GET** /repos/{owner}/{repo}/code-scanning/alerts | List code scanning alerts for a repository
+*CodeScanningApi* | [**codeScanning/listCodeqlDatabases**](Apis/CodeScanningApi.http#codescanning/listcodeqldatabases) | **GET** /repos/{owner}/{repo}/code-scanning/codeql/databases | List CodeQL databases for a repository
+*CodeScanningApi* | [**codeScanning/listRecentAnalyses**](Apis/CodeScanningApi.http#codescanning/listrecentanalyses) | **GET** /repos/{owner}/{repo}/code-scanning/analyses | List code scanning analyses for a repository
+*CodeScanningApi* | [**codeScanning/updateAlert**](Apis/CodeScanningApi.http#codescanning/updatealert) | **PATCH** /repos/{owner}/{repo}/code-scanning/alerts/{alert_number} | Update a code scanning alert
+*CodeScanningApi* | [**codeScanning/updateDefaultSetup**](Apis/CodeScanningApi.http#codescanning/updatedefaultsetup) | **PATCH** /repos/{owner}/{repo}/code-scanning/default-setup | Update a code scanning default setup configuration
+*CodeScanningApi* | [**codeScanning/uploadSarif**](Apis/CodeScanningApi.http#codescanning/uploadsarif) | **POST** /repos/{owner}/{repo}/code-scanning/sarifs | Upload an analysis as SARIF data
+*CodesOfConductApi* | [**codesOfConduct/getAllCodesOfConduct**](Apis/CodesOfConductApi.http#codesofconduct/getallcodesofconduct) | **GET** /codes_of_conduct | Get all codes of conduct
+*CodesOfConductApi* | [**codesOfConduct/getConductCode**](Apis/CodesOfConductApi.http#codesofconduct/getconductcode) | **GET** /codes_of_conduct/{key} | Get a code of conduct
+*CodespacesApi* | [**codespaces/addRepositoryForSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/addrepositoryforsecretforauthenticateduser) | **PUT** /user/codespaces/secrets/{secret_name}/repositories/{repository_id} | Add a selected repository to a user secret
+*CodespacesApi* | [**codespaces/addSelectedRepoToOrgSecret**](Apis/CodespacesApi.http#codespaces/addselectedrepotoorgsecret) | **PUT** /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id} | Add selected repository to an organization secret
+*CodespacesApi* | [**codespaces/checkPermissionsForDevcontainer**](Apis/CodespacesApi.http#codespaces/checkpermissionsfordevcontainer) | **GET** /repos/{owner}/{repo}/codespaces/permissions_check | Check if permissions defined by a devcontainer have been accepted by the authenticated user
+*CodespacesApi* | [**codespaces/codespaceMachinesForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/codespacemachinesforauthenticateduser) | **GET** /user/codespaces/{codespace_name}/machines | List machine types for a codespace
+*CodespacesApi* | [**codespaces/createForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/createforauthenticateduser) | **POST** /user/codespaces | Create a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/createOrUpdateOrgSecret**](Apis/CodespacesApi.http#codespaces/createorupdateorgsecret) | **PUT** /orgs/{org}/codespaces/secrets/{secret_name} | Create or update an organization secret
+*CodespacesApi* | [**codespaces/createOrUpdateRepoSecret**](Apis/CodespacesApi.http#codespaces/createorupdatereposecret) | **PUT** /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | Create or update a repository secret
+*CodespacesApi* | [**codespaces/createOrUpdateSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/createorupdatesecretforauthenticateduser) | **PUT** /user/codespaces/secrets/{secret_name} | Create or update a secret for the authenticated user
+*CodespacesApi* | [**codespaces/createWithPrForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/createwithprforauthenticateduser) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/codespaces | Create a codespace from a pull request
+*CodespacesApi* | [**codespaces/createWithRepoForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/createwithrepoforauthenticateduser) | **POST** /repos/{owner}/{repo}/codespaces | Create a codespace in a repository
+*CodespacesApi* | [**codespaces/deleteCodespacesAccessUsers**](Apis/CodespacesApi.http#codespaces/deletecodespacesaccessusers) | **DELETE** /orgs/{org}/codespaces/access/selected_users | Remove users from Codespaces access for an organization
+*CodespacesApi* | [**codespaces/deleteForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/deleteforauthenticateduser) | **DELETE** /user/codespaces/{codespace_name} | Delete a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/deleteFromOrganization**](Apis/CodespacesApi.http#codespaces/deletefromorganization) | **DELETE** /orgs/{org}/members/{username}/codespaces/{codespace_name} | Delete a codespace from the organization
+*CodespacesApi* | [**codespaces/deleteOrgSecret**](Apis/CodespacesApi.http#codespaces/deleteorgsecret) | **DELETE** /orgs/{org}/codespaces/secrets/{secret_name} | Delete an organization secret
+*CodespacesApi* | [**codespaces/deleteRepoSecret**](Apis/CodespacesApi.http#codespaces/deletereposecret) | **DELETE** /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | Delete a repository secret
+*CodespacesApi* | [**codespaces/deleteSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/deletesecretforauthenticateduser) | **DELETE** /user/codespaces/secrets/{secret_name} | Delete a secret for the authenticated user
+*CodespacesApi* | [**codespaces/exportForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/exportforauthenticateduser) | **POST** /user/codespaces/{codespace_name}/exports | Export a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/getCodespacesForUserInOrg**](Apis/CodespacesApi.http#codespaces/getcodespacesforuserinorg) | **GET** /orgs/{org}/members/{username}/codespaces | List codespaces for a user in organization
+*CodespacesApi* | [**codespaces/getExportDetailsForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/getexportdetailsforauthenticateduser) | **GET** /user/codespaces/{codespace_name}/exports/{export_id} | Get details about a codespace export
+*CodespacesApi* | [**codespaces/getForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/getforauthenticateduser) | **GET** /user/codespaces/{codespace_name} | Get a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/getOrgPublicKey**](Apis/CodespacesApi.http#codespaces/getorgpublickey) | **GET** /orgs/{org}/codespaces/secrets/public-key | Get an organization public key
+*CodespacesApi* | [**codespaces/getOrgSecret**](Apis/CodespacesApi.http#codespaces/getorgsecret) | **GET** /orgs/{org}/codespaces/secrets/{secret_name} | Get an organization secret
+*CodespacesApi* | [**codespaces/getPublicKeyForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/getpublickeyforauthenticateduser) | **GET** /user/codespaces/secrets/public-key | Get public key for the authenticated user
+*CodespacesApi* | [**codespaces/getRepoPublicKey**](Apis/CodespacesApi.http#codespaces/getrepopublickey) | **GET** /repos/{owner}/{repo}/codespaces/secrets/public-key | Get a repository public key
+*CodespacesApi* | [**codespaces/getRepoSecret**](Apis/CodespacesApi.http#codespaces/getreposecret) | **GET** /repos/{owner}/{repo}/codespaces/secrets/{secret_name} | Get a repository secret
+*CodespacesApi* | [**codespaces/getSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/getsecretforauthenticateduser) | **GET** /user/codespaces/secrets/{secret_name} | Get a secret for the authenticated user
+*CodespacesApi* | [**codespaces/listDevcontainersInRepositoryForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/listdevcontainersinrepositoryforauthenticateduser) | **GET** /repos/{owner}/{repo}/codespaces/devcontainers | List devcontainer configurations in a repository for the authenticated user
+*CodespacesApi* | [**codespaces/listForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/listforauthenticateduser) | **GET** /user/codespaces | List codespaces for the authenticated user
+*CodespacesApi* | [**codespaces/listInOrganization**](Apis/CodespacesApi.http#codespaces/listinorganization) | **GET** /orgs/{org}/codespaces | List codespaces for the organization
+*CodespacesApi* | [**codespaces/listInRepositoryForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/listinrepositoryforauthenticateduser) | **GET** /repos/{owner}/{repo}/codespaces | List codespaces in a repository for the authenticated user
+*CodespacesApi* | [**codespaces/listOrgSecrets**](Apis/CodespacesApi.http#codespaces/listorgsecrets) | **GET** /orgs/{org}/codespaces/secrets | List organization secrets
+*CodespacesApi* | [**codespaces/listRepoSecrets**](Apis/CodespacesApi.http#codespaces/listreposecrets) | **GET** /repos/{owner}/{repo}/codespaces/secrets | List repository secrets
+*CodespacesApi* | [**codespaces/listRepositoriesForSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/listrepositoriesforsecretforauthenticateduser) | **GET** /user/codespaces/secrets/{secret_name}/repositories | List selected repositories for a user secret
+*CodespacesApi* | [**codespaces/listSecretsForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/listsecretsforauthenticateduser) | **GET** /user/codespaces/secrets | List secrets for the authenticated user
+*CodespacesApi* | [**codespaces/listSelectedReposForOrgSecret**](Apis/CodespacesApi.http#codespaces/listselectedreposfororgsecret) | **GET** /orgs/{org}/codespaces/secrets/{secret_name}/repositories | List selected repositories for an organization secret
+*CodespacesApi* | [**codespaces/preFlightWithRepoForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/preflightwithrepoforauthenticateduser) | **GET** /repos/{owner}/{repo}/codespaces/new | Get default attributes for a codespace
+*CodespacesApi* | [**codespaces/publishForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/publishforauthenticateduser) | **POST** /user/codespaces/{codespace_name}/publish | Create a repository from an unpublished codespace
+*CodespacesApi* | [**codespaces/removeRepositoryForSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/removerepositoryforsecretforauthenticateduser) | **DELETE** /user/codespaces/secrets/{secret_name}/repositories/{repository_id} | Remove a selected repository from a user secret
+*CodespacesApi* | [**codespaces/removeSelectedRepoFromOrgSecret**](Apis/CodespacesApi.http#codespaces/removeselectedrepofromorgsecret) | **DELETE** /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id} | Remove selected repository from an organization secret
+*CodespacesApi* | [**codespaces/repoMachinesForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/repomachinesforauthenticateduser) | **GET** /repos/{owner}/{repo}/codespaces/machines | List available machine types for a repository
+*CodespacesApi* | [**codespaces/setCodespacesAccess**](Apis/CodespacesApi.http#codespaces/setcodespacesaccess) | **PUT** /orgs/{org}/codespaces/access | Manage access control for organization codespaces
+*CodespacesApi* | [**codespaces/setCodespacesAccessUsers**](Apis/CodespacesApi.http#codespaces/setcodespacesaccessusers) | **POST** /orgs/{org}/codespaces/access/selected_users | Add users to Codespaces access for an organization
+*CodespacesApi* | [**codespaces/setRepositoriesForSecretForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/setrepositoriesforsecretforauthenticateduser) | **PUT** /user/codespaces/secrets/{secret_name}/repositories | Set selected repositories for a user secret
+*CodespacesApi* | [**codespaces/setSelectedReposForOrgSecret**](Apis/CodespacesApi.http#codespaces/setselectedreposfororgsecret) | **PUT** /orgs/{org}/codespaces/secrets/{secret_name}/repositories | Set selected repositories for an organization secret
+*CodespacesApi* | [**codespaces/startForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/startforauthenticateduser) | **POST** /user/codespaces/{codespace_name}/start | Start a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/stopForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/stopforauthenticateduser) | **POST** /user/codespaces/{codespace_name}/stop | Stop a codespace for the authenticated user
+*CodespacesApi* | [**codespaces/stopInOrganization**](Apis/CodespacesApi.http#codespaces/stopinorganization) | **POST** /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop | Stop a codespace for an organization user
+*CodespacesApi* | [**codespaces/updateForAuthenticatedUser**](Apis/CodespacesApi.http#codespaces/updateforauthenticateduser) | **PATCH** /user/codespaces/{codespace_name} | Update a codespace for the authenticated user
+*CopilotApi* | [**copilot/addCopilotSeatsForTeams**](Apis/CopilotApi.http#copilot/addcopilotseatsforteams) | **POST** /orgs/{org}/copilot/billing/selected_teams | Add teams to the Copilot subscription for an organization
+*CopilotApi* | [**copilot/addCopilotSeatsForUsers**](Apis/CopilotApi.http#copilot/addcopilotseatsforusers) | **POST** /orgs/{org}/copilot/billing/selected_users | Add users to the Copilot subscription for an organization
+*CopilotApi* | [**copilot/cancelCopilotSeatAssignmentForTeams**](Apis/CopilotApi.http#copilot/cancelcopilotseatassignmentforteams) | **DELETE** /orgs/{org}/copilot/billing/selected_teams | Remove teams from the Copilot subscription for an organization
+*CopilotApi* | [**copilot/cancelCopilotSeatAssignmentForUsers**](Apis/CopilotApi.http#copilot/cancelcopilotseatassignmentforusers) | **DELETE** /orgs/{org}/copilot/billing/selected_users | Remove users from the Copilot subscription for an organization
+*CopilotApi* | [**copilot/getCopilotOrganizationDetails**](Apis/CopilotApi.http#copilot/getcopilotorganizationdetails) | **GET** /orgs/{org}/copilot/billing | Get Copilot seat information and settings for an organization
+*CopilotApi* | [**copilot/getCopilotSeatDetailsForUser**](Apis/CopilotApi.http#copilot/getcopilotseatdetailsforuser) | **GET** /orgs/{org}/members/{username}/copilot | Get Copilot seat assignment details for a user
+*CopilotApi* | [**copilot/listCopilotSeats**](Apis/CopilotApi.http#copilot/listcopilotseats) | **GET** /orgs/{org}/copilot/billing/seats | List all Copilot seat assignments for an organization
+*DependabotApi* | [**dependabot/addSelectedRepoToOrgSecret**](Apis/DependabotApi.http#dependabot/addselectedrepotoorgsecret) | **PUT** /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id} | Add selected repository to an organization secret
+*DependabotApi* | [**dependabot/createOrUpdateOrgSecret**](Apis/DependabotApi.http#dependabot/createorupdateorgsecret) | **PUT** /orgs/{org}/dependabot/secrets/{secret_name} | Create or update an organization secret
+*DependabotApi* | [**dependabot/createOrUpdateRepoSecret**](Apis/DependabotApi.http#dependabot/createorupdatereposecret) | **PUT** /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | Create or update a repository secret
+*DependabotApi* | [**dependabot/deleteOrgSecret**](Apis/DependabotApi.http#dependabot/deleteorgsecret) | **DELETE** /orgs/{org}/dependabot/secrets/{secret_name} | Delete an organization secret
+*DependabotApi* | [**dependabot/deleteRepoSecret**](Apis/DependabotApi.http#dependabot/deletereposecret) | **DELETE** /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | Delete a repository secret
+*DependabotApi* | [**dependabot/getAlert**](Apis/DependabotApi.http#dependabot/getalert) | **GET** /repos/{owner}/{repo}/dependabot/alerts/{alert_number} | Get a Dependabot alert
+*DependabotApi* | [**dependabot/getOrgPublicKey**](Apis/DependabotApi.http#dependabot/getorgpublickey) | **GET** /orgs/{org}/dependabot/secrets/public-key | Get an organization public key
+*DependabotApi* | [**dependabot/getOrgSecret**](Apis/DependabotApi.http#dependabot/getorgsecret) | **GET** /orgs/{org}/dependabot/secrets/{secret_name} | Get an organization secret
+*DependabotApi* | [**dependabot/getRepoPublicKey**](Apis/DependabotApi.http#dependabot/getrepopublickey) | **GET** /repos/{owner}/{repo}/dependabot/secrets/public-key | Get a repository public key
+*DependabotApi* | [**dependabot/getRepoSecret**](Apis/DependabotApi.http#dependabot/getreposecret) | **GET** /repos/{owner}/{repo}/dependabot/secrets/{secret_name} | Get a repository secret
+*DependabotApi* | [**dependabot/listAlertsForEnterprise**](Apis/DependabotApi.http#dependabot/listalertsforenterprise) | **GET** /enterprises/{enterprise}/dependabot/alerts | List Dependabot alerts for an enterprise
+*DependabotApi* | [**dependabot/listAlertsForOrg**](Apis/DependabotApi.http#dependabot/listalertsfororg) | **GET** /orgs/{org}/dependabot/alerts | List Dependabot alerts for an organization
+*DependabotApi* | [**dependabot/listAlertsForRepo**](Apis/DependabotApi.http#dependabot/listalertsforrepo) | **GET** /repos/{owner}/{repo}/dependabot/alerts | List Dependabot alerts for a repository
+*DependabotApi* | [**dependabot/listOrgSecrets**](Apis/DependabotApi.http#dependabot/listorgsecrets) | **GET** /orgs/{org}/dependabot/secrets | List organization secrets
+*DependabotApi* | [**dependabot/listRepoSecrets**](Apis/DependabotApi.http#dependabot/listreposecrets) | **GET** /repos/{owner}/{repo}/dependabot/secrets | List repository secrets
+*DependabotApi* | [**dependabot/listSelectedReposForOrgSecret**](Apis/DependabotApi.http#dependabot/listselectedreposfororgsecret) | **GET** /orgs/{org}/dependabot/secrets/{secret_name}/repositories | List selected repositories for an organization secret
+*DependabotApi* | [**dependabot/removeSelectedRepoFromOrgSecret**](Apis/DependabotApi.http#dependabot/removeselectedrepofromorgsecret) | **DELETE** /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id} | Remove selected repository from an organization secret
+*DependabotApi* | [**dependabot/setSelectedReposForOrgSecret**](Apis/DependabotApi.http#dependabot/setselectedreposfororgsecret) | **PUT** /orgs/{org}/dependabot/secrets/{secret_name}/repositories | Set selected repositories for an organization secret
+*DependabotApi* | [**dependabot/updateAlert**](Apis/DependabotApi.http#dependabot/updatealert) | **PATCH** /repos/{owner}/{repo}/dependabot/alerts/{alert_number} | Update a Dependabot alert
+*DependencyGraphApi* | [**dependencyGraph/createRepositorySnapshot**](Apis/DependencyGraphApi.http#dependencygraph/createrepositorysnapshot) | **POST** /repos/{owner}/{repo}/dependency-graph/snapshots | Create a snapshot of dependencies for a repository
+*DependencyGraphApi* | [**dependencyGraph/diffRange**](Apis/DependencyGraphApi.http#dependencygraph/diffrange) | **GET** /repos/{owner}/{repo}/dependency-graph/compare/{basehead} | Get a diff of the dependencies between commits
+*DependencyGraphApi* | [**dependencyGraph/exportSbom**](Apis/DependencyGraphApi.http#dependencygraph/exportsbom) | **GET** /repos/{owner}/{repo}/dependency-graph/sbom | Export a software bill of materials (SBOM) for a repository.
+*EmojisApi* | [**emojis/get**](Apis/EmojisApi.http#emojis/get) | **GET** /emojis | Get emojis
+*GistsApi* | [**gists/checkIsStarred**](Apis/GistsApi.http#gists/checkisstarred) | **GET** /gists/{gist_id}/star | Check if a gist is starred
+*GistsApi* | [**gists/create**](Apis/GistsApi.http#gists/create) | **POST** /gists | Create a gist
+*GistsApi* | [**gists/createComment**](Apis/GistsApi.http#gists/createcomment) | **POST** /gists/{gist_id}/comments | Create a gist comment
+*GistsApi* | [**gists/delete**](Apis/GistsApi.http#gists/delete) | **DELETE** /gists/{gist_id} | Delete a gist
+*GistsApi* | [**gists/deleteComment**](Apis/GistsApi.http#gists/deletecomment) | **DELETE** /gists/{gist_id}/comments/{comment_id} | Delete a gist comment
+*GistsApi* | [**gists/fork**](Apis/GistsApi.http#gists/fork) | **POST** /gists/{gist_id}/forks | Fork a gist
+*GistsApi* | [**gists/get**](Apis/GistsApi.http#gists/get) | **GET** /gists/{gist_id} | Get a gist
+*GistsApi* | [**gists/getComment**](Apis/GistsApi.http#gists/getcomment) | **GET** /gists/{gist_id}/comments/{comment_id} | Get a gist comment
+*GistsApi* | [**gists/getRevision**](Apis/GistsApi.http#gists/getrevision) | **GET** /gists/{gist_id}/{sha} | Get a gist revision
+*GistsApi* | [**gists/list**](Apis/GistsApi.http#gists/list) | **GET** /gists | List gists for the authenticated user
+*GistsApi* | [**gists/listComments**](Apis/GistsApi.http#gists/listcomments) | **GET** /gists/{gist_id}/comments | List gist comments
+*GistsApi* | [**gists/listCommits**](Apis/GistsApi.http#gists/listcommits) | **GET** /gists/{gist_id}/commits | List gist commits
+*GistsApi* | [**gists/listForUser**](Apis/GistsApi.http#gists/listforuser) | **GET** /users/{username}/gists | List gists for a user
+*GistsApi* | [**gists/listForks**](Apis/GistsApi.http#gists/listforks) | **GET** /gists/{gist_id}/forks | List gist forks
+*GistsApi* | [**gists/listPublic**](Apis/GistsApi.http#gists/listpublic) | **GET** /gists/public | List public gists
+*GistsApi* | [**gists/listStarred**](Apis/GistsApi.http#gists/liststarred) | **GET** /gists/starred | List starred gists
+*GistsApi* | [**gists/star**](Apis/GistsApi.http#gists/star) | **PUT** /gists/{gist_id}/star | Star a gist
+*GistsApi* | [**gists/unstar**](Apis/GistsApi.http#gists/unstar) | **DELETE** /gists/{gist_id}/star | Unstar a gist
+*GistsApi* | [**gists/update**](Apis/GistsApi.http#gists/update) | **PATCH** /gists/{gist_id} | Update a gist
+*GistsApi* | [**gists/updateComment**](Apis/GistsApi.http#gists/updatecomment) | **PATCH** /gists/{gist_id}/comments/{comment_id} | Update a gist comment
+*GitApi* | [**git/createBlob**](Apis/GitApi.http#git/createblob) | **POST** /repos/{owner}/{repo}/git/blobs | Create a blob
+*GitApi* | [**git/createCommit**](Apis/GitApi.http#git/createcommit) | **POST** /repos/{owner}/{repo}/git/commits | Create a commit
+*GitApi* | [**git/createRef**](Apis/GitApi.http#git/createref) | **POST** /repos/{owner}/{repo}/git/refs | Create a reference
+*GitApi* | [**git/createTag**](Apis/GitApi.http#git/createtag) | **POST** /repos/{owner}/{repo}/git/tags | Create a tag object
+*GitApi* | [**git/createTree**](Apis/GitApi.http#git/createtree) | **POST** /repos/{owner}/{repo}/git/trees | Create a tree
+*GitApi* | [**git/deleteRef**](Apis/GitApi.http#git/deleteref) | **DELETE** /repos/{owner}/{repo}/git/refs/{ref} | Delete a reference
+*GitApi* | [**git/getBlob**](Apis/GitApi.http#git/getblob) | **GET** /repos/{owner}/{repo}/git/blobs/{file_sha} | Get a blob
+*GitApi* | [**git/getCommit**](Apis/GitApi.http#git/getcommit) | **GET** /repos/{owner}/{repo}/git/commits/{commit_sha} | Get a commit object
+*GitApi* | [**git/getRef**](Apis/GitApi.http#git/getref) | **GET** /repos/{owner}/{repo}/git/ref/{ref} | Get a reference
+*GitApi* | [**git/getTag**](Apis/GitApi.http#git/gettag) | **GET** /repos/{owner}/{repo}/git/tags/{tag_sha} | Get a tag
+*GitApi* | [**git/getTree**](Apis/GitApi.http#git/gettree) | **GET** /repos/{owner}/{repo}/git/trees/{tree_sha} | Get a tree
+*GitApi* | [**git/listMatchingRefs**](Apis/GitApi.http#git/listmatchingrefs) | **GET** /repos/{owner}/{repo}/git/matching-refs/{ref} | List matching references
+*GitApi* | [**git/updateRef**](Apis/GitApi.http#git/updateref) | **PATCH** /repos/{owner}/{repo}/git/refs/{ref} | Update a reference
+*GitignoreApi* | [**gitignore/getAllTemplates**](Apis/GitignoreApi.http#gitignore/getalltemplates) | **GET** /gitignore/templates | Get all gitignore templates
+*GitignoreApi* | [**gitignore/getTemplate**](Apis/GitignoreApi.http#gitignore/gettemplate) | **GET** /gitignore/templates/{name} | Get a gitignore template
+*InteractionsApi* | [**interactions/getRestrictionsForAuthenticatedUser**](Apis/InteractionsApi.http#interactions/getrestrictionsforauthenticateduser) | **GET** /user/interaction-limits | Get interaction restrictions for your public repositories
+*InteractionsApi* | [**interactions/getRestrictionsForOrg**](Apis/InteractionsApi.http#interactions/getrestrictionsfororg) | **GET** /orgs/{org}/interaction-limits | Get interaction restrictions for an organization
+*InteractionsApi* | [**interactions/getRestrictionsForRepo**](Apis/InteractionsApi.http#interactions/getrestrictionsforrepo) | **GET** /repos/{owner}/{repo}/interaction-limits | Get interaction restrictions for a repository
+*InteractionsApi* | [**interactions/removeRestrictionsForAuthenticatedUser**](Apis/InteractionsApi.http#interactions/removerestrictionsforauthenticateduser) | **DELETE** /user/interaction-limits | Remove interaction restrictions from your public repositories
+*InteractionsApi* | [**interactions/removeRestrictionsForOrg**](Apis/InteractionsApi.http#interactions/removerestrictionsfororg) | **DELETE** /orgs/{org}/interaction-limits | Remove interaction restrictions for an organization
+*InteractionsApi* | [**interactions/removeRestrictionsForRepo**](Apis/InteractionsApi.http#interactions/removerestrictionsforrepo) | **DELETE** /repos/{owner}/{repo}/interaction-limits | Remove interaction restrictions for a repository
+*InteractionsApi* | [**interactions/setRestrictionsForAuthenticatedUser**](Apis/InteractionsApi.http#interactions/setrestrictionsforauthenticateduser) | **PUT** /user/interaction-limits | Set interaction restrictions for your public repositories
+*InteractionsApi* | [**interactions/setRestrictionsForOrg**](Apis/InteractionsApi.http#interactions/setrestrictionsfororg) | **PUT** /orgs/{org}/interaction-limits | Set interaction restrictions for an organization
+*InteractionsApi* | [**interactions/setRestrictionsForRepo**](Apis/InteractionsApi.http#interactions/setrestrictionsforrepo) | **PUT** /repos/{owner}/{repo}/interaction-limits | Set interaction restrictions for a repository
+*IssuesApi* | [**issues/addAssignees**](Apis/IssuesApi.http#issues/addassignees) | **POST** /repos/{owner}/{repo}/issues/{issue_number}/assignees | Add assignees to an issue
+*IssuesApi* | [**issues/addLabels**](Apis/IssuesApi.http#issues/addlabels) | **POST** /repos/{owner}/{repo}/issues/{issue_number}/labels | Add labels to an issue
+*IssuesApi* | [**issues/checkUserCanBeAssigned**](Apis/IssuesApi.http#issues/checkusercanbeassigned) | **GET** /repos/{owner}/{repo}/assignees/{assignee} | Check if a user can be assigned
+*IssuesApi* | [**issues/checkUserCanBeAssignedToIssue**](Apis/IssuesApi.http#issues/checkusercanbeassignedtoissue) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee} | Check if a user can be assigned to a issue
+*IssuesApi* | [**issues/create**](Apis/IssuesApi.http#issues/create) | **POST** /repos/{owner}/{repo}/issues | Create an issue
+*IssuesApi* | [**issues/createComment**](Apis/IssuesApi.http#issues/createcomment) | **POST** /repos/{owner}/{repo}/issues/{issue_number}/comments | Create an issue comment
+*IssuesApi* | [**issues/createLabel**](Apis/IssuesApi.http#issues/createlabel) | **POST** /repos/{owner}/{repo}/labels | Create a label
+*IssuesApi* | [**issues/createMilestone**](Apis/IssuesApi.http#issues/createmilestone) | **POST** /repos/{owner}/{repo}/milestones | Create a milestone
+*IssuesApi* | [**issues/deleteComment**](Apis/IssuesApi.http#issues/deletecomment) | **DELETE** /repos/{owner}/{repo}/issues/comments/{comment_id} | Delete an issue comment
+*IssuesApi* | [**issues/deleteLabel**](Apis/IssuesApi.http#issues/deletelabel) | **DELETE** /repos/{owner}/{repo}/labels/{name} | Delete a label
+*IssuesApi* | [**issues/deleteMilestone**](Apis/IssuesApi.http#issues/deletemilestone) | **DELETE** /repos/{owner}/{repo}/milestones/{milestone_number} | Delete a milestone
+*IssuesApi* | [**issues/get**](Apis/IssuesApi.http#issues/get) | **GET** /repos/{owner}/{repo}/issues/{issue_number} | Get an issue
+*IssuesApi* | [**issues/getComment**](Apis/IssuesApi.http#issues/getcomment) | **GET** /repos/{owner}/{repo}/issues/comments/{comment_id} | Get an issue comment
+*IssuesApi* | [**issues/getEvent**](Apis/IssuesApi.http#issues/getevent) | **GET** /repos/{owner}/{repo}/issues/events/{event_id} | Get an issue event
+*IssuesApi* | [**issues/getLabel**](Apis/IssuesApi.http#issues/getlabel) | **GET** /repos/{owner}/{repo}/labels/{name} | Get a label
+*IssuesApi* | [**issues/getMilestone**](Apis/IssuesApi.http#issues/getmilestone) | **GET** /repos/{owner}/{repo}/milestones/{milestone_number} | Get a milestone
+*IssuesApi* | [**issues/list**](Apis/IssuesApi.http#issues/list) | **GET** /issues | List issues assigned to the authenticated user
+*IssuesApi* | [**issues/listAssignees**](Apis/IssuesApi.http#issues/listassignees) | **GET** /repos/{owner}/{repo}/assignees | List assignees
+*IssuesApi* | [**issues/listComments**](Apis/IssuesApi.http#issues/listcomments) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/comments | List issue comments
+*IssuesApi* | [**issues/listCommentsForRepo**](Apis/IssuesApi.http#issues/listcommentsforrepo) | **GET** /repos/{owner}/{repo}/issues/comments | List issue comments for a repository
+*IssuesApi* | [**issues/listEvents**](Apis/IssuesApi.http#issues/listevents) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/events | List issue events
+*IssuesApi* | [**issues/listEventsForRepo**](Apis/IssuesApi.http#issues/listeventsforrepo) | **GET** /repos/{owner}/{repo}/issues/events | List issue events for a repository
+*IssuesApi* | [**issues/listEventsForTimeline**](Apis/IssuesApi.http#issues/listeventsfortimeline) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/timeline | List timeline events for an issue
+*IssuesApi* | [**issues/listForAuthenticatedUser**](Apis/IssuesApi.http#issues/listforauthenticateduser) | **GET** /user/issues | List user account issues assigned to the authenticated user
+*IssuesApi* | [**issues/listForOrg**](Apis/IssuesApi.http#issues/listfororg) | **GET** /orgs/{org}/issues | List organization issues assigned to the authenticated user
+*IssuesApi* | [**issues/listForRepo**](Apis/IssuesApi.http#issues/listforrepo) | **GET** /repos/{owner}/{repo}/issues | List repository issues
+*IssuesApi* | [**issues/listLabelsForMilestone**](Apis/IssuesApi.http#issues/listlabelsformilestone) | **GET** /repos/{owner}/{repo}/milestones/{milestone_number}/labels | List labels for issues in a milestone
+*IssuesApi* | [**issues/listLabelsForRepo**](Apis/IssuesApi.http#issues/listlabelsforrepo) | **GET** /repos/{owner}/{repo}/labels | List labels for a repository
+*IssuesApi* | [**issues/listLabelsOnIssue**](Apis/IssuesApi.http#issues/listlabelsonissue) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/labels | List labels for an issue
+*IssuesApi* | [**issues/listMilestones**](Apis/IssuesApi.http#issues/listmilestones) | **GET** /repos/{owner}/{repo}/milestones | List milestones
+*IssuesApi* | [**issues/lock**](Apis/IssuesApi.http#issues/lock) | **PUT** /repos/{owner}/{repo}/issues/{issue_number}/lock | Lock an issue
+*IssuesApi* | [**issues/removeAllLabels**](Apis/IssuesApi.http#issues/removealllabels) | **DELETE** /repos/{owner}/{repo}/issues/{issue_number}/labels | Remove all labels from an issue
+*IssuesApi* | [**issues/removeAssignees**](Apis/IssuesApi.http#issues/removeassignees) | **DELETE** /repos/{owner}/{repo}/issues/{issue_number}/assignees | Remove assignees from an issue
+*IssuesApi* | [**issues/removeLabel**](Apis/IssuesApi.http#issues/removelabel) | **DELETE** /repos/{owner}/{repo}/issues/{issue_number}/labels/{name} | Remove a label from an issue
+*IssuesApi* | [**issues/setLabels**](Apis/IssuesApi.http#issues/setlabels) | **PUT** /repos/{owner}/{repo}/issues/{issue_number}/labels | Set labels for an issue
+*IssuesApi* | [**issues/unlock**](Apis/IssuesApi.http#issues/unlock) | **DELETE** /repos/{owner}/{repo}/issues/{issue_number}/lock | Unlock an issue
+*IssuesApi* | [**issues/update**](Apis/IssuesApi.http#issues/update) | **PATCH** /repos/{owner}/{repo}/issues/{issue_number} | Update an issue
+*IssuesApi* | [**issues/updateComment**](Apis/IssuesApi.http#issues/updatecomment) | **PATCH** /repos/{owner}/{repo}/issues/comments/{comment_id} | Update an issue comment
+*IssuesApi* | [**issues/updateLabel**](Apis/IssuesApi.http#issues/updatelabel) | **PATCH** /repos/{owner}/{repo}/labels/{name} | Update a label
+*IssuesApi* | [**issues/updateMilestone**](Apis/IssuesApi.http#issues/updatemilestone) | **PATCH** /repos/{owner}/{repo}/milestones/{milestone_number} | Update a milestone
+*LicensesApi* | [**licenses/get**](Apis/LicensesApi.http#licenses/get) | **GET** /licenses/{license} | Get a license
+*LicensesApi* | [**licenses/getAllCommonlyUsed**](Apis/LicensesApi.http#licenses/getallcommonlyused) | **GET** /licenses | Get all commonly used licenses
+*LicensesApi* | [**licenses/getForRepo**](Apis/LicensesApi.http#licenses/getforrepo) | **GET** /repos/{owner}/{repo}/license | Get the license for a repository
+*MarkdownApi* | [**markdown/render**](Apis/MarkdownApi.http#markdown/render) | **POST** /markdown | Render a Markdown document
+*MarkdownApi* | [**markdown/renderRaw**](Apis/MarkdownApi.http#markdown/renderraw) | **POST** /markdown/raw | Render a Markdown document in raw mode
+*MetaApi* | [**meta/get**](Apis/MetaApi.http#meta/get) | **GET** /meta | Get GitHub meta information
+*MetaApi* | [**meta/getAllVersions**](Apis/MetaApi.http#meta/getallversions) | **GET** /versions | Get all API versions
+*MetaApi* | [**meta/getOctocat**](Apis/MetaApi.http#meta/getoctocat) | **GET** /octocat | Get Octocat
+*MetaApi* | [**meta/getZen**](Apis/MetaApi.http#meta/getzen) | **GET** /zen | Get the Zen of GitHub
+*MetaApi* | [**meta/root**](Apis/MetaApi.http#meta/root) | **GET** / | GitHub API Root
+*MigrationsApi* | [**migrations/cancelImport**](Apis/MigrationsApi.http#migrations/cancelimport) | **DELETE** /repos/{owner}/{repo}/import | Cancel an import
+*MigrationsApi* | [**migrations/deleteArchiveForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/deletearchiveforauthenticateduser) | **DELETE** /user/migrations/{migration_id}/archive | Delete a user migration archive
+*MigrationsApi* | [**migrations/deleteArchiveForOrg**](Apis/MigrationsApi.http#migrations/deletearchivefororg) | **DELETE** /orgs/{org}/migrations/{migration_id}/archive | Delete an organization migration archive
+*MigrationsApi* | [**migrations/downloadArchiveForOrg**](Apis/MigrationsApi.http#migrations/downloadarchivefororg) | **GET** /orgs/{org}/migrations/{migration_id}/archive | Download an organization migration archive
+*MigrationsApi* | [**migrations/getArchiveForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/getarchiveforauthenticateduser) | **GET** /user/migrations/{migration_id}/archive | Download a user migration archive
+*MigrationsApi* | [**migrations/getCommitAuthors**](Apis/MigrationsApi.http#migrations/getcommitauthors) | **GET** /repos/{owner}/{repo}/import/authors | Get commit authors
+*MigrationsApi* | [**migrations/getImportStatus**](Apis/MigrationsApi.http#migrations/getimportstatus) | **GET** /repos/{owner}/{repo}/import | Get an import status
+*MigrationsApi* | [**migrations/getLargeFiles**](Apis/MigrationsApi.http#migrations/getlargefiles) | **GET** /repos/{owner}/{repo}/import/large_files | Get large files
+*MigrationsApi* | [**migrations/getStatusForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/getstatusforauthenticateduser) | **GET** /user/migrations/{migration_id} | Get a user migration status
+*MigrationsApi* | [**migrations/getStatusForOrg**](Apis/MigrationsApi.http#migrations/getstatusfororg) | **GET** /orgs/{org}/migrations/{migration_id} | Get an organization migration status
+*MigrationsApi* | [**migrations/listForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/listforauthenticateduser) | **GET** /user/migrations | List user migrations
+*MigrationsApi* | [**migrations/listForOrg**](Apis/MigrationsApi.http#migrations/listfororg) | **GET** /orgs/{org}/migrations | List organization migrations
+*MigrationsApi* | [**migrations/listReposForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/listreposforauthenticateduser) | **GET** /user/migrations/{migration_id}/repositories | List repositories for a user migration
+*MigrationsApi* | [**migrations/listReposForOrg**](Apis/MigrationsApi.http#migrations/listreposfororg) | **GET** /orgs/{org}/migrations/{migration_id}/repositories | List repositories in an organization migration
+*MigrationsApi* | [**migrations/mapCommitAuthor**](Apis/MigrationsApi.http#migrations/mapcommitauthor) | **PATCH** /repos/{owner}/{repo}/import/authors/{author_id} | Map a commit author
+*MigrationsApi* | [**migrations/setLfsPreference**](Apis/MigrationsApi.http#migrations/setlfspreference) | **PATCH** /repos/{owner}/{repo}/import/lfs | Update Git LFS preference
+*MigrationsApi* | [**migrations/startForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/startforauthenticateduser) | **POST** /user/migrations | Start a user migration
+*MigrationsApi* | [**migrations/startForOrg**](Apis/MigrationsApi.http#migrations/startfororg) | **POST** /orgs/{org}/migrations | Start an organization migration
+*MigrationsApi* | [**migrations/startImport**](Apis/MigrationsApi.http#migrations/startimport) | **PUT** /repos/{owner}/{repo}/import | Start an import
+*MigrationsApi* | [**migrations/unlockRepoForAuthenticatedUser**](Apis/MigrationsApi.http#migrations/unlockrepoforauthenticateduser) | **DELETE** /user/migrations/{migration_id}/repos/{repo_name}/lock | Unlock a user repository
+*MigrationsApi* | [**migrations/unlockRepoForOrg**](Apis/MigrationsApi.http#migrations/unlockrepofororg) | **DELETE** /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock | Unlock an organization repository
+*MigrationsApi* | [**migrations/updateImport**](Apis/MigrationsApi.http#migrations/updateimport) | **PATCH** /repos/{owner}/{repo}/import | Update an import
+*OidcApi* | [**oidc/getOidcCustomSubTemplateForOrg**](Apis/OidcApi.http#oidc/getoidccustomsubtemplatefororg) | **GET** /orgs/{org}/actions/oidc/customization/sub | Get the customization template for an OIDC subject claim for an organization
+*OidcApi* | [**oidc/updateOidcCustomSubTemplateForOrg**](Apis/OidcApi.http#oidc/updateoidccustomsubtemplatefororg) | **PUT** /orgs/{org}/actions/oidc/customization/sub | Set the customization template for an OIDC subject claim for an organization
+*OrgsApi* | [**orgs/addSecurityManagerTeam**](Apis/OrgsApi.http#orgs/addsecuritymanagerteam) | **PUT** /orgs/{org}/security-managers/teams/{team_slug} | Add a security manager team
+*OrgsApi* | [**orgs/assignTeamToOrgRole**](Apis/OrgsApi.http#orgs/assignteamtoorgrole) | **PUT** /orgs/{org}/organization-roles/teams/{team_slug}/{role_id} | Assign an organization role to a team
+*OrgsApi* | [**orgs/assignUserToOrgRole**](Apis/OrgsApi.http#orgs/assignusertoorgrole) | **PUT** /orgs/{org}/organization-roles/users/{username}/{role_id} | Assign an organization role to a user
+*OrgsApi* | [**orgs/blockUser**](Apis/OrgsApi.http#orgs/blockuser) | **PUT** /orgs/{org}/blocks/{username} | Block a user from an organization
+*OrgsApi* | [**orgs/cancelInvitation**](Apis/OrgsApi.http#orgs/cancelinvitation) | **DELETE** /orgs/{org}/invitations/{invitation_id} | Cancel an organization invitation
+*OrgsApi* | [**orgs/checkBlockedUser**](Apis/OrgsApi.http#orgs/checkblockeduser) | **GET** /orgs/{org}/blocks/{username} | Check if a user is blocked by an organization
+*OrgsApi* | [**orgs/checkMembershipForUser**](Apis/OrgsApi.http#orgs/checkmembershipforuser) | **GET** /orgs/{org}/members/{username} | Check organization membership for a user
+*OrgsApi* | [**orgs/checkPublicMembershipForUser**](Apis/OrgsApi.http#orgs/checkpublicmembershipforuser) | **GET** /orgs/{org}/public_members/{username} | Check public organization membership for a user
+*OrgsApi* | [**orgs/convertMemberToOutsideCollaborator**](Apis/OrgsApi.http#orgs/convertmembertooutsidecollaborator) | **PUT** /orgs/{org}/outside_collaborators/{username} | Convert an organization member to outside collaborator
+*OrgsApi* | [**orgs/createCustomOrganizationRole**](Apis/OrgsApi.http#orgs/createcustomorganizationrole) | **POST** /orgs/{org}/organization-roles | Create a custom organization role
+*OrgsApi* | [**orgs/createInvitation**](Apis/OrgsApi.http#orgs/createinvitation) | **POST** /orgs/{org}/invitations | Create an organization invitation
+*OrgsApi* | [**orgs/createOrUpdateCustomProperties**](Apis/OrgsApi.http#orgs/createorupdatecustomproperties) | **PATCH** /orgs/{org}/properties/schema | Create or update custom properties for an organization
+*OrgsApi* | [**orgs/createOrUpdateCustomPropertiesValuesForRepos**](Apis/OrgsApi.http#orgs/createorupdatecustompropertiesvaluesforrepos) | **PATCH** /orgs/{org}/properties/values | Create or update custom property values for organization repositories
+*OrgsApi* | [**orgs/createOrUpdateCustomProperty**](Apis/OrgsApi.http#orgs/createorupdatecustomproperty) | **PUT** /orgs/{org}/properties/schema/{custom_property_name} | Create or update a custom property for an organization
+*OrgsApi* | [**orgs/createWebhook**](Apis/OrgsApi.http#orgs/createwebhook) | **POST** /orgs/{org}/hooks | Create an organization webhook
+*OrgsApi* | [**orgs/delete**](Apis/OrgsApi.http#orgs/delete) | **DELETE** /orgs/{org} | Delete an organization
+*OrgsApi* | [**orgs/deleteCustomOrganizationRole**](Apis/OrgsApi.http#orgs/deletecustomorganizationrole) | **DELETE** /orgs/{org}/organization-roles/{role_id} | Delete a custom organization role.
+*OrgsApi* | [**orgs/deleteWebhook**](Apis/OrgsApi.http#orgs/deletewebhook) | **DELETE** /orgs/{org}/hooks/{hook_id} | Delete an organization webhook
+*OrgsApi* | [**orgs/enableOrDisableSecurityProductOnAllOrgRepos**](Apis/OrgsApi.http#orgs/enableordisablesecurityproductonallorgrepos) | **POST** /orgs/{org}/{security_product}/{enablement} | Enable or disable a security feature for an organization
+*OrgsApi* | [**orgs/get**](Apis/OrgsApi.http#orgs/get) | **GET** /orgs/{org} | Get an organization
+*OrgsApi* | [**orgs/getAllCustomProperties**](Apis/OrgsApi.http#orgs/getallcustomproperties) | **GET** /orgs/{org}/properties/schema | Get all custom properties for an organization
+*OrgsApi* | [**orgs/getCustomProperty**](Apis/OrgsApi.http#orgs/getcustomproperty) | **GET** /orgs/{org}/properties/schema/{custom_property_name} | Get a custom property for an organization
+*OrgsApi* | [**orgs/getMembershipForAuthenticatedUser**](Apis/OrgsApi.http#orgs/getmembershipforauthenticateduser) | **GET** /user/memberships/orgs/{org} | Get an organization membership for the authenticated user
+*OrgsApi* | [**orgs/getMembershipForUser**](Apis/OrgsApi.http#orgs/getmembershipforuser) | **GET** /orgs/{org}/memberships/{username} | Get organization membership for a user
+*OrgsApi* | [**orgs/getOrgRole**](Apis/OrgsApi.http#orgs/getorgrole) | **GET** /orgs/{org}/organization-roles/{role_id} | Get an organization role
+*OrgsApi* | [**orgs/getWebhook**](Apis/OrgsApi.http#orgs/getwebhook) | **GET** /orgs/{org}/hooks/{hook_id} | Get an organization webhook
+*OrgsApi* | [**orgs/getWebhookConfigForOrg**](Apis/OrgsApi.http#orgs/getwebhookconfigfororg) | **GET** /orgs/{org}/hooks/{hook_id}/config | Get a webhook configuration for an organization
+*OrgsApi* | [**orgs/getWebhookDelivery**](Apis/OrgsApi.http#orgs/getwebhookdelivery) | **GET** /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id} | Get a webhook delivery for an organization webhook
+*OrgsApi* | [**orgs/list**](Apis/OrgsApi.http#orgs/list) | **GET** /organizations | List organizations
+*OrgsApi* | [**orgs/listAppInstallations**](Apis/OrgsApi.http#orgs/listappinstallations) | **GET** /orgs/{org}/installations | List app installations for an organization
+*OrgsApi* | [**orgs/listBlockedUsers**](Apis/OrgsApi.http#orgs/listblockedusers) | **GET** /orgs/{org}/blocks | List users blocked by an organization
+*OrgsApi* | [**orgs/listCustomPropertiesValuesForRepos**](Apis/OrgsApi.http#orgs/listcustompropertiesvaluesforrepos) | **GET** /orgs/{org}/properties/values | List custom property values for organization repositories
+*OrgsApi* | [**orgs/listFailedInvitations**](Apis/OrgsApi.http#orgs/listfailedinvitations) | **GET** /orgs/{org}/failed_invitations | List failed organization invitations
+*OrgsApi* | [**orgs/listForAuthenticatedUser**](Apis/OrgsApi.http#orgs/listforauthenticateduser) | **GET** /user/orgs | List organizations for the authenticated user
+*OrgsApi* | [**orgs/listForUser**](Apis/OrgsApi.http#orgs/listforuser) | **GET** /users/{username}/orgs | List organizations for a user
+*OrgsApi* | [**orgs/listInvitationTeams**](Apis/OrgsApi.http#orgs/listinvitationteams) | **GET** /orgs/{org}/invitations/{invitation_id}/teams | List organization invitation teams
+*OrgsApi* | [**orgs/listMembers**](Apis/OrgsApi.http#orgs/listmembers) | **GET** /orgs/{org}/members | List organization members
+*OrgsApi* | [**orgs/listMembershipsForAuthenticatedUser**](Apis/OrgsApi.http#orgs/listmembershipsforauthenticateduser) | **GET** /user/memberships/orgs | List organization memberships for the authenticated user
+*OrgsApi* | [**orgs/listOrgRoleTeams**](Apis/OrgsApi.http#orgs/listorgroleteams) | **GET** /orgs/{org}/organization-roles/{role_id}/teams | List teams that are assigned to an organization role
+*OrgsApi* | [**orgs/listOrgRoleUsers**](Apis/OrgsApi.http#orgs/listorgroleusers) | **GET** /orgs/{org}/organization-roles/{role_id}/users | List users that are assigned to an organization role
+*OrgsApi* | [**orgs/listOrgRoles**](Apis/OrgsApi.http#orgs/listorgroles) | **GET** /orgs/{org}/organization-roles | Get all organization roles for an organization
+*OrgsApi* | [**orgs/listOrganizationFineGrainedPermissions**](Apis/OrgsApi.http#orgs/listorganizationfinegrainedpermissions) | **GET** /orgs/{org}/organization-fine-grained-permissions | List organization fine-grained permissions for an organization
+*OrgsApi* | [**orgs/listOutsideCollaborators**](Apis/OrgsApi.http#orgs/listoutsidecollaborators) | **GET** /orgs/{org}/outside_collaborators | List outside collaborators for an organization
+*OrgsApi* | [**orgs/listPatGrantRepositories**](Apis/OrgsApi.http#orgs/listpatgrantrepositories) | **GET** /orgs/{org}/personal-access-tokens/{pat_id}/repositories | List repositories a fine-grained personal access token has access to
+*OrgsApi* | [**orgs/listPatGrantRequestRepositories**](Apis/OrgsApi.http#orgs/listpatgrantrequestrepositories) | **GET** /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories | List repositories requested to be accessed by a fine-grained personal access token
+*OrgsApi* | [**orgs/listPatGrantRequests**](Apis/OrgsApi.http#orgs/listpatgrantrequests) | **GET** /orgs/{org}/personal-access-token-requests | List requests to access organization resources with fine-grained personal access tokens
+*OrgsApi* | [**orgs/listPatGrants**](Apis/OrgsApi.http#orgs/listpatgrants) | **GET** /orgs/{org}/personal-access-tokens | List fine-grained personal access tokens with access to organization resources
+*OrgsApi* | [**orgs/listPendingInvitations**](Apis/OrgsApi.http#orgs/listpendinginvitations) | **GET** /orgs/{org}/invitations | List pending organization invitations
+*OrgsApi* | [**orgs/listPublicMembers**](Apis/OrgsApi.http#orgs/listpublicmembers) | **GET** /orgs/{org}/public_members | List public organization members
+*OrgsApi* | [**orgs/listSecurityManagerTeams**](Apis/OrgsApi.http#orgs/listsecuritymanagerteams) | **GET** /orgs/{org}/security-managers | List security manager teams
+*OrgsApi* | [**orgs/listWebhookDeliveries**](Apis/OrgsApi.http#orgs/listwebhookdeliveries) | **GET** /orgs/{org}/hooks/{hook_id}/deliveries | List deliveries for an organization webhook
+*OrgsApi* | [**orgs/listWebhooks**](Apis/OrgsApi.http#orgs/listwebhooks) | **GET** /orgs/{org}/hooks | List organization webhooks
+*OrgsApi* | [**orgs/patchCustomOrganizationRole**](Apis/OrgsApi.http#orgs/patchcustomorganizationrole) | **PATCH** /orgs/{org}/organization-roles/{role_id} | Update a custom organization role
+*OrgsApi* | [**orgs/pingWebhook**](Apis/OrgsApi.http#orgs/pingwebhook) | **POST** /orgs/{org}/hooks/{hook_id}/pings | Ping an organization webhook
+*OrgsApi* | [**orgs/redeliverWebhookDelivery**](Apis/OrgsApi.http#orgs/redeliverwebhookdelivery) | **POST** /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts | Redeliver a delivery for an organization webhook
+*OrgsApi* | [**orgs/removeCustomProperty**](Apis/OrgsApi.http#orgs/removecustomproperty) | **DELETE** /orgs/{org}/properties/schema/{custom_property_name} | Remove a custom property for an organization
+*OrgsApi* | [**orgs/removeMember**](Apis/OrgsApi.http#orgs/removemember) | **DELETE** /orgs/{org}/members/{username} | Remove an organization member
+*OrgsApi* | [**orgs/removeMembershipForUser**](Apis/OrgsApi.http#orgs/removemembershipforuser) | **DELETE** /orgs/{org}/memberships/{username} | Remove organization membership for a user
+*OrgsApi* | [**orgs/removeOutsideCollaborator**](Apis/OrgsApi.http#orgs/removeoutsidecollaborator) | **DELETE** /orgs/{org}/outside_collaborators/{username} | Remove outside collaborator from an organization
+*OrgsApi* | [**orgs/removePublicMembershipForAuthenticatedUser**](Apis/OrgsApi.http#orgs/removepublicmembershipforauthenticateduser) | **DELETE** /orgs/{org}/public_members/{username} | Remove public organization membership for the authenticated user
+*OrgsApi* | [**orgs/removeSecurityManagerTeam**](Apis/OrgsApi.http#orgs/removesecuritymanagerteam) | **DELETE** /orgs/{org}/security-managers/teams/{team_slug} | Remove a security manager team
+*OrgsApi* | [**orgs/reviewPatGrantRequest**](Apis/OrgsApi.http#orgs/reviewpatgrantrequest) | **POST** /orgs/{org}/personal-access-token-requests/{pat_request_id} | Review a request to access organization resources with a fine-grained personal access token
+*OrgsApi* | [**orgs/reviewPatGrantRequestsInBulk**](Apis/OrgsApi.http#orgs/reviewpatgrantrequestsinbulk) | **POST** /orgs/{org}/personal-access-token-requests | Review requests to access organization resources with fine-grained personal access tokens
+*OrgsApi* | [**orgs/revokeAllOrgRolesTeam**](Apis/OrgsApi.http#orgs/revokeallorgrolesteam) | **DELETE** /orgs/{org}/organization-roles/teams/{team_slug} | Remove all organization roles for a team
+*OrgsApi* | [**orgs/revokeAllOrgRolesUser**](Apis/OrgsApi.http#orgs/revokeallorgrolesuser) | **DELETE** /orgs/{org}/organization-roles/users/{username} | Remove all organization roles for a user
+*OrgsApi* | [**orgs/revokeOrgRoleTeam**](Apis/OrgsApi.http#orgs/revokeorgroleteam) | **DELETE** /orgs/{org}/organization-roles/teams/{team_slug}/{role_id} | Remove an organization role from a team
+*OrgsApi* | [**orgs/revokeOrgRoleUser**](Apis/OrgsApi.http#orgs/revokeorgroleuser) | **DELETE** /orgs/{org}/organization-roles/users/{username}/{role_id} | Remove an organization role from a user
+*OrgsApi* | [**orgs/setMembershipForUser**](Apis/OrgsApi.http#orgs/setmembershipforuser) | **PUT** /orgs/{org}/memberships/{username} | Set organization membership for a user
+*OrgsApi* | [**orgs/setPublicMembershipForAuthenticatedUser**](Apis/OrgsApi.http#orgs/setpublicmembershipforauthenticateduser) | **PUT** /orgs/{org}/public_members/{username} | Set public organization membership for the authenticated user
+*OrgsApi* | [**orgs/unblockUser**](Apis/OrgsApi.http#orgs/unblockuser) | **DELETE** /orgs/{org}/blocks/{username} | Unblock a user from an organization
+*OrgsApi* | [**orgs/update**](Apis/OrgsApi.http#orgs/update) | **PATCH** /orgs/{org} | Update an organization
+*OrgsApi* | [**orgs/updateMembershipForAuthenticatedUser**](Apis/OrgsApi.http#orgs/updatemembershipforauthenticateduser) | **PATCH** /user/memberships/orgs/{org} | Update an organization membership for the authenticated user
+*OrgsApi* | [**orgs/updatePatAccess**](Apis/OrgsApi.http#orgs/updatepataccess) | **POST** /orgs/{org}/personal-access-tokens/{pat_id} | Update the access a fine-grained personal access token has to organization resources
+*OrgsApi* | [**orgs/updatePatAccesses**](Apis/OrgsApi.http#orgs/updatepataccesses) | **POST** /orgs/{org}/personal-access-tokens | Update the access to organization resources via fine-grained personal access tokens
+*OrgsApi* | [**orgs/updateWebhook**](Apis/OrgsApi.http#orgs/updatewebhook) | **PATCH** /orgs/{org}/hooks/{hook_id} | Update an organization webhook
+*OrgsApi* | [**orgs/updateWebhookConfigForOrg**](Apis/OrgsApi.http#orgs/updatewebhookconfigfororg) | **PATCH** /orgs/{org}/hooks/{hook_id}/config | Update a webhook configuration for an organization
+*PackagesApi* | [**packages/deletePackageForAuthenticatedUser**](Apis/PackagesApi.http#packages/deletepackageforauthenticateduser) | **DELETE** /user/packages/{package_type}/{package_name} | Delete a package for the authenticated user
+*PackagesApi* | [**packages/deletePackageForOrg**](Apis/PackagesApi.http#packages/deletepackagefororg) | **DELETE** /orgs/{org}/packages/{package_type}/{package_name} | Delete a package for an organization
+*PackagesApi* | [**packages/deletePackageForUser**](Apis/PackagesApi.http#packages/deletepackageforuser) | **DELETE** /users/{username}/packages/{package_type}/{package_name} | Delete a package for a user
+*PackagesApi* | [**packages/deletePackageVersionForAuthenticatedUser**](Apis/PackagesApi.http#packages/deletepackageversionforauthenticateduser) | **DELETE** /user/packages/{package_type}/{package_name}/versions/{package_version_id} | Delete a package version for the authenticated user
+*PackagesApi* | [**packages/deletePackageVersionForOrg**](Apis/PackagesApi.http#packages/deletepackageversionfororg) | **DELETE** /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id} | Delete package version for an organization
+*PackagesApi* | [**packages/deletePackageVersionForUser**](Apis/PackagesApi.http#packages/deletepackageversionforuser) | **DELETE** /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id} | Delete package version for a user
+*PackagesApi* | [**packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser**](Apis/PackagesApi.http#packages/getallpackageversionsforpackageownedbyauthenticateduser) | **GET** /user/packages/{package_type}/{package_name}/versions | List package versions for a package owned by the authenticated user
+*PackagesApi* | [**packages/getAllPackageVersionsForPackageOwnedByOrg**](Apis/PackagesApi.http#packages/getallpackageversionsforpackageownedbyorg) | **GET** /orgs/{org}/packages/{package_type}/{package_name}/versions | List package versions for a package owned by an organization
+*PackagesApi* | [**packages/getAllPackageVersionsForPackageOwnedByUser**](Apis/PackagesApi.http#packages/getallpackageversionsforpackageownedbyuser) | **GET** /users/{username}/packages/{package_type}/{package_name}/versions | List package versions for a package owned by a user
+*PackagesApi* | [**packages/getPackageForAuthenticatedUser**](Apis/PackagesApi.http#packages/getpackageforauthenticateduser) | **GET** /user/packages/{package_type}/{package_name} | Get a package for the authenticated user
+*PackagesApi* | [**packages/getPackageForOrganization**](Apis/PackagesApi.http#packages/getpackagefororganization) | **GET** /orgs/{org}/packages/{package_type}/{package_name} | Get a package for an organization
+*PackagesApi* | [**packages/getPackageForUser**](Apis/PackagesApi.http#packages/getpackageforuser) | **GET** /users/{username}/packages/{package_type}/{package_name} | Get a package for a user
+*PackagesApi* | [**packages/getPackageVersionForAuthenticatedUser**](Apis/PackagesApi.http#packages/getpackageversionforauthenticateduser) | **GET** /user/packages/{package_type}/{package_name}/versions/{package_version_id} | Get a package version for the authenticated user
+*PackagesApi* | [**packages/getPackageVersionForOrganization**](Apis/PackagesApi.http#packages/getpackageversionfororganization) | **GET** /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id} | Get a package version for an organization
+*PackagesApi* | [**packages/getPackageVersionForUser**](Apis/PackagesApi.http#packages/getpackageversionforuser) | **GET** /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id} | Get a package version for a user
+*PackagesApi* | [**packages/listDockerMigrationConflictingPackagesForAuthenticatedUser**](Apis/PackagesApi.http#packages/listdockermigrationconflictingpackagesforauthenticateduser) | **GET** /user/docker/conflicts | Get list of conflicting packages during Docker migration for authenticated-user
+*PackagesApi* | [**packages/listDockerMigrationConflictingPackagesForOrganization**](Apis/PackagesApi.http#packages/listdockermigrationconflictingpackagesfororganization) | **GET** /orgs/{org}/docker/conflicts | Get list of conflicting packages during Docker migration for organization
+*PackagesApi* | [**packages/listDockerMigrationConflictingPackagesForUser**](Apis/PackagesApi.http#packages/listdockermigrationconflictingpackagesforuser) | **GET** /users/{username}/docker/conflicts | Get list of conflicting packages during Docker migration for user
+*PackagesApi* | [**packages/listPackagesForAuthenticatedUser**](Apis/PackagesApi.http#packages/listpackagesforauthenticateduser) | **GET** /user/packages | List packages for the authenticated user's namespace
+*PackagesApi* | [**packages/listPackagesForOrganization**](Apis/PackagesApi.http#packages/listpackagesfororganization) | **GET** /orgs/{org}/packages | List packages for an organization
+*PackagesApi* | [**packages/listPackagesForUser**](Apis/PackagesApi.http#packages/listpackagesforuser) | **GET** /users/{username}/packages | List packages for a user
+*PackagesApi* | [**packages/restorePackageForAuthenticatedUser**](Apis/PackagesApi.http#packages/restorepackageforauthenticateduser) | **POST** /user/packages/{package_type}/{package_name}/restore | Restore a package for the authenticated user
+*PackagesApi* | [**packages/restorePackageForOrg**](Apis/PackagesApi.http#packages/restorepackagefororg) | **POST** /orgs/{org}/packages/{package_type}/{package_name}/restore | Restore a package for an organization
+*PackagesApi* | [**packages/restorePackageForUser**](Apis/PackagesApi.http#packages/restorepackageforuser) | **POST** /users/{username}/packages/{package_type}/{package_name}/restore | Restore a package for a user
+*PackagesApi* | [**packages/restorePackageVersionForAuthenticatedUser**](Apis/PackagesApi.http#packages/restorepackageversionforauthenticateduser) | **POST** /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore | Restore a package version for the authenticated user
+*PackagesApi* | [**packages/restorePackageVersionForOrg**](Apis/PackagesApi.http#packages/restorepackageversionfororg) | **POST** /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore | Restore package version for an organization
+*PackagesApi* | [**packages/restorePackageVersionForUser**](Apis/PackagesApi.http#packages/restorepackageversionforuser) | **POST** /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore | Restore package version for a user
+*ProjectsApi* | [**projects/addCollaborator**](Apis/ProjectsApi.http#projects/addcollaborator) | **PUT** /projects/{project_id}/collaborators/{username} | Add project collaborator
+*ProjectsApi* | [**projects/createCard**](Apis/ProjectsApi.http#projects/createcard) | **POST** /projects/columns/{column_id}/cards | Create a project card
+*ProjectsApi* | [**projects/createColumn**](Apis/ProjectsApi.http#projects/createcolumn) | **POST** /projects/{project_id}/columns | Create a project column
+*ProjectsApi* | [**projects/createForAuthenticatedUser**](Apis/ProjectsApi.http#projects/createforauthenticateduser) | **POST** /user/projects | Create a user project
+*ProjectsApi* | [**projects/createForOrg**](Apis/ProjectsApi.http#projects/createfororg) | **POST** /orgs/{org}/projects | Create an organization project
+*ProjectsApi* | [**projects/createForRepo**](Apis/ProjectsApi.http#projects/createforrepo) | **POST** /repos/{owner}/{repo}/projects | Create a repository project
+*ProjectsApi* | [**projects/delete**](Apis/ProjectsApi.http#projects/delete) | **DELETE** /projects/{project_id} | Delete a project
+*ProjectsApi* | [**projects/deleteCard**](Apis/ProjectsApi.http#projects/deletecard) | **DELETE** /projects/columns/cards/{card_id} | Delete a project card
+*ProjectsApi* | [**projects/deleteColumn**](Apis/ProjectsApi.http#projects/deletecolumn) | **DELETE** /projects/columns/{column_id} | Delete a project column
+*ProjectsApi* | [**projects/get**](Apis/ProjectsApi.http#projects/get) | **GET** /projects/{project_id} | Get a project
+*ProjectsApi* | [**projects/getCard**](Apis/ProjectsApi.http#projects/getcard) | **GET** /projects/columns/cards/{card_id} | Get a project card
+*ProjectsApi* | [**projects/getColumn**](Apis/ProjectsApi.http#projects/getcolumn) | **GET** /projects/columns/{column_id} | Get a project column
+*ProjectsApi* | [**projects/getPermissionForUser**](Apis/ProjectsApi.http#projects/getpermissionforuser) | **GET** /projects/{project_id}/collaborators/{username}/permission | Get project permission for a user
+*ProjectsApi* | [**projects/listCards**](Apis/ProjectsApi.http#projects/listcards) | **GET** /projects/columns/{column_id}/cards | List project cards
+*ProjectsApi* | [**projects/listCollaborators**](Apis/ProjectsApi.http#projects/listcollaborators) | **GET** /projects/{project_id}/collaborators | List project collaborators
+*ProjectsApi* | [**projects/listColumns**](Apis/ProjectsApi.http#projects/listcolumns) | **GET** /projects/{project_id}/columns | List project columns
+*ProjectsApi* | [**projects/listForOrg**](Apis/ProjectsApi.http#projects/listfororg) | **GET** /orgs/{org}/projects | List organization projects
+*ProjectsApi* | [**projects/listForRepo**](Apis/ProjectsApi.http#projects/listforrepo) | **GET** /repos/{owner}/{repo}/projects | List repository projects
+*ProjectsApi* | [**projects/listForUser**](Apis/ProjectsApi.http#projects/listforuser) | **GET** /users/{username}/projects | List user projects
+*ProjectsApi* | [**projects/moveCard**](Apis/ProjectsApi.http#projects/movecard) | **POST** /projects/columns/cards/{card_id}/moves | Move a project card
+*ProjectsApi* | [**projects/moveColumn**](Apis/ProjectsApi.http#projects/movecolumn) | **POST** /projects/columns/{column_id}/moves | Move a project column
+*ProjectsApi* | [**projects/removeCollaborator**](Apis/ProjectsApi.http#projects/removecollaborator) | **DELETE** /projects/{project_id}/collaborators/{username} | Remove user as a collaborator
+*ProjectsApi* | [**projects/update**](Apis/ProjectsApi.http#projects/update) | **PATCH** /projects/{project_id} | Update a project
+*ProjectsApi* | [**projects/updateCard**](Apis/ProjectsApi.http#projects/updatecard) | **PATCH** /projects/columns/cards/{card_id} | Update an existing project card
+*ProjectsApi* | [**projects/updateColumn**](Apis/ProjectsApi.http#projects/updatecolumn) | **PATCH** /projects/columns/{column_id} | Update an existing project column
+*PullsApi* | [**pulls/checkIfMerged**](Apis/PullsApi.http#pulls/checkifmerged) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/merge | Check if a pull request has been merged
+*PullsApi* | [**pulls/create**](Apis/PullsApi.http#pulls/create) | **POST** /repos/{owner}/{repo}/pulls | Create a pull request
+*PullsApi* | [**pulls/createReplyForReviewComment**](Apis/PullsApi.http#pulls/createreplyforreviewcomment) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies | Create a reply for a review comment
+*PullsApi* | [**pulls/createReview**](Apis/PullsApi.http#pulls/createreview) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/reviews | Create a review for a pull request
+*PullsApi* | [**pulls/createReviewComment**](Apis/PullsApi.http#pulls/createreviewcomment) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/comments | Create a review comment for a pull request
+*PullsApi* | [**pulls/deletePendingReview**](Apis/PullsApi.http#pulls/deletependingreview) | **DELETE** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id} | Delete a pending review for a pull request
+*PullsApi* | [**pulls/deleteReviewComment**](Apis/PullsApi.http#pulls/deletereviewcomment) | **DELETE** /repos/{owner}/{repo}/pulls/comments/{comment_id} | Delete a review comment for a pull request
+*PullsApi* | [**pulls/dismissReview**](Apis/PullsApi.http#pulls/dismissreview) | **PUT** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals | Dismiss a review for a pull request
+*PullsApi* | [**pulls/get**](Apis/PullsApi.http#pulls/get) | **GET** /repos/{owner}/{repo}/pulls/{pull_number} | Get a pull request
+*PullsApi* | [**pulls/getReview**](Apis/PullsApi.http#pulls/getreview) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id} | Get a review for a pull request
+*PullsApi* | [**pulls/getReviewComment**](Apis/PullsApi.http#pulls/getreviewcomment) | **GET** /repos/{owner}/{repo}/pulls/comments/{comment_id} | Get a review comment for a pull request
+*PullsApi* | [**pulls/list**](Apis/PullsApi.http#pulls/list) | **GET** /repos/{owner}/{repo}/pulls | List pull requests
+*PullsApi* | [**pulls/listCommentsForReview**](Apis/PullsApi.http#pulls/listcommentsforreview) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments | List comments for a pull request review
+*PullsApi* | [**pulls/listCommits**](Apis/PullsApi.http#pulls/listcommits) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/commits | List commits on a pull request
+*PullsApi* | [**pulls/listFiles**](Apis/PullsApi.http#pulls/listfiles) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/files | List pull requests files
+*PullsApi* | [**pulls/listRequestedReviewers**](Apis/PullsApi.http#pulls/listrequestedreviewers) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers | Get all requested reviewers for a pull request
+*PullsApi* | [**pulls/listReviewComments**](Apis/PullsApi.http#pulls/listreviewcomments) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/comments | List review comments on a pull request
+*PullsApi* | [**pulls/listReviewCommentsForRepo**](Apis/PullsApi.http#pulls/listreviewcommentsforrepo) | **GET** /repos/{owner}/{repo}/pulls/comments | List review comments in a repository
+*PullsApi* | [**pulls/listReviews**](Apis/PullsApi.http#pulls/listreviews) | **GET** /repos/{owner}/{repo}/pulls/{pull_number}/reviews | List reviews for a pull request
+*PullsApi* | [**pulls/merge**](Apis/PullsApi.http#pulls/merge) | **PUT** /repos/{owner}/{repo}/pulls/{pull_number}/merge | Merge a pull request
+*PullsApi* | [**pulls/removeRequestedReviewers**](Apis/PullsApi.http#pulls/removerequestedreviewers) | **DELETE** /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers | Remove requested reviewers from a pull request
+*PullsApi* | [**pulls/requestReviewers**](Apis/PullsApi.http#pulls/requestreviewers) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers | Request reviewers for a pull request
+*PullsApi* | [**pulls/submitReview**](Apis/PullsApi.http#pulls/submitreview) | **POST** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events | Submit a review for a pull request
+*PullsApi* | [**pulls/update**](Apis/PullsApi.http#pulls/update) | **PATCH** /repos/{owner}/{repo}/pulls/{pull_number} | Update a pull request
+*PullsApi* | [**pulls/updateBranch**](Apis/PullsApi.http#pulls/updatebranch) | **PUT** /repos/{owner}/{repo}/pulls/{pull_number}/update-branch | Update a pull request branch
+*PullsApi* | [**pulls/updateReview**](Apis/PullsApi.http#pulls/updatereview) | **PUT** /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id} | Update a review for a pull request
+*PullsApi* | [**pulls/updateReviewComment**](Apis/PullsApi.http#pulls/updatereviewcomment) | **PATCH** /repos/{owner}/{repo}/pulls/comments/{comment_id} | Update a review comment for a pull request
+*RateLimitApi* | [**rateLimit/get**](Apis/RateLimitApi.http#ratelimit/get) | **GET** /rate_limit | Get rate limit status for the authenticated user
+*ReactionsApi* | [**reactions/createForCommitComment**](Apis/ReactionsApi.http#reactions/createforcommitcomment) | **POST** /repos/{owner}/{repo}/comments/{comment_id}/reactions | Create reaction for a commit comment
+*ReactionsApi* | [**reactions/createForIssue**](Apis/ReactionsApi.http#reactions/createforissue) | **POST** /repos/{owner}/{repo}/issues/{issue_number}/reactions | Create reaction for an issue
+*ReactionsApi* | [**reactions/createForIssueComment**](Apis/ReactionsApi.http#reactions/createforissuecomment) | **POST** /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions | Create reaction for an issue comment
+*ReactionsApi* | [**reactions/createForPullRequestReviewComment**](Apis/ReactionsApi.http#reactions/createforpullrequestreviewcomment) | **POST** /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions | Create reaction for a pull request review comment
+*ReactionsApi* | [**reactions/createForRelease**](Apis/ReactionsApi.http#reactions/createforrelease) | **POST** /repos/{owner}/{repo}/releases/{release_id}/reactions | Create reaction for a release
+*ReactionsApi* | [**reactions/createForTeamDiscussionCommentInOrg**](Apis/ReactionsApi.http#reactions/createforteamdiscussioncommentinorg) | **POST** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions | Create reaction for a team discussion comment
+*ReactionsApi* | [**reactions/createForTeamDiscussionCommentLegacy**](Apis/ReactionsApi.http#reactions/createforteamdiscussioncommentlegacy) | **POST** /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions | Create reaction for a team discussion comment (Legacy)
+*ReactionsApi* | [**reactions/createForTeamDiscussionInOrg**](Apis/ReactionsApi.http#reactions/createforteamdiscussioninorg) | **POST** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions | Create reaction for a team discussion
+*ReactionsApi* | [**reactions/createForTeamDiscussionLegacy**](Apis/ReactionsApi.http#reactions/createforteamdiscussionlegacy) | **POST** /teams/{team_id}/discussions/{discussion_number}/reactions | Create reaction for a team discussion (Legacy)
+*ReactionsApi* | [**reactions/deleteForCommitComment**](Apis/ReactionsApi.http#reactions/deleteforcommitcomment) | **DELETE** /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id} | Delete a commit comment reaction
+*ReactionsApi* | [**reactions/deleteForIssue**](Apis/ReactionsApi.http#reactions/deleteforissue) | **DELETE** /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id} | Delete an issue reaction
+*ReactionsApi* | [**reactions/deleteForIssueComment**](Apis/ReactionsApi.http#reactions/deleteforissuecomment) | **DELETE** /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id} | Delete an issue comment reaction
+*ReactionsApi* | [**reactions/deleteForPullRequestComment**](Apis/ReactionsApi.http#reactions/deleteforpullrequestcomment) | **DELETE** /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id} | Delete a pull request comment reaction
+*ReactionsApi* | [**reactions/deleteForRelease**](Apis/ReactionsApi.http#reactions/deleteforrelease) | **DELETE** /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id} | Delete a release reaction
+*ReactionsApi* | [**reactions/deleteForTeamDiscussion**](Apis/ReactionsApi.http#reactions/deleteforteamdiscussion) | **DELETE** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id} | Delete team discussion reaction
+*ReactionsApi* | [**reactions/deleteForTeamDiscussionComment**](Apis/ReactionsApi.http#reactions/deleteforteamdiscussioncomment) | **DELETE** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id} | Delete team discussion comment reaction
+*ReactionsApi* | [**reactions/listForCommitComment**](Apis/ReactionsApi.http#reactions/listforcommitcomment) | **GET** /repos/{owner}/{repo}/comments/{comment_id}/reactions | List reactions for a commit comment
+*ReactionsApi* | [**reactions/listForIssue**](Apis/ReactionsApi.http#reactions/listforissue) | **GET** /repos/{owner}/{repo}/issues/{issue_number}/reactions | List reactions for an issue
+*ReactionsApi* | [**reactions/listForIssueComment**](Apis/ReactionsApi.http#reactions/listforissuecomment) | **GET** /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions | List reactions for an issue comment
+*ReactionsApi* | [**reactions/listForPullRequestReviewComment**](Apis/ReactionsApi.http#reactions/listforpullrequestreviewcomment) | **GET** /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions | List reactions for a pull request review comment
+*ReactionsApi* | [**reactions/listForRelease**](Apis/ReactionsApi.http#reactions/listforrelease) | **GET** /repos/{owner}/{repo}/releases/{release_id}/reactions | List reactions for a release
+*ReactionsApi* | [**reactions/listForTeamDiscussionCommentInOrg**](Apis/ReactionsApi.http#reactions/listforteamdiscussioncommentinorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions | List reactions for a team discussion comment
+*ReactionsApi* | [**reactions/listForTeamDiscussionCommentLegacy**](Apis/ReactionsApi.http#reactions/listforteamdiscussioncommentlegacy) | **GET** /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions | List reactions for a team discussion comment (Legacy)
+*ReactionsApi* | [**reactions/listForTeamDiscussionInOrg**](Apis/ReactionsApi.http#reactions/listforteamdiscussioninorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions | List reactions for a team discussion
+*ReactionsApi* | [**reactions/listForTeamDiscussionLegacy**](Apis/ReactionsApi.http#reactions/listforteamdiscussionlegacy) | **GET** /teams/{team_id}/discussions/{discussion_number}/reactions | List reactions for a team discussion (Legacy)
+*ReposApi* | [**repos/acceptInvitationForAuthenticatedUser**](Apis/ReposApi.http#repos/acceptinvitationforauthenticateduser) | **PATCH** /user/repository_invitations/{invitation_id} | Accept a repository invitation
+*ReposApi* | [**repos/addAppAccessRestrictions**](Apis/ReposApi.http#repos/addappaccessrestrictions) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps | Add app access restrictions
+*ReposApi* | [**repos/addCollaborator**](Apis/ReposApi.http#repos/addcollaborator) | **PUT** /repos/{owner}/{repo}/collaborators/{username} | Add a repository collaborator
+*ReposApi* | [**repos/addStatusCheckContexts**](Apis/ReposApi.http#repos/addstatuscheckcontexts) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts | Add status check contexts
+*ReposApi* | [**repos/addTeamAccessRestrictions**](Apis/ReposApi.http#repos/addteamaccessrestrictions) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams | Add team access restrictions
+*ReposApi* | [**repos/addUserAccessRestrictions**](Apis/ReposApi.http#repos/adduseraccessrestrictions) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users | Add user access restrictions
+*ReposApi* | [**repos/cancelPagesDeployment**](Apis/ReposApi.http#repos/cancelpagesdeployment) | **POST** /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel | Cancel a GitHub Pages deployment
+*ReposApi* | [**repos/checkAutomatedSecurityFixes**](Apis/ReposApi.http#repos/checkautomatedsecurityfixes) | **GET** /repos/{owner}/{repo}/automated-security-fixes | Check if automated security fixes are enabled for a repository
+*ReposApi* | [**repos/checkCollaborator**](Apis/ReposApi.http#repos/checkcollaborator) | **GET** /repos/{owner}/{repo}/collaborators/{username} | Check if a user is a repository collaborator
+*ReposApi* | [**repos/checkVulnerabilityAlerts**](Apis/ReposApi.http#repos/checkvulnerabilityalerts) | **GET** /repos/{owner}/{repo}/vulnerability-alerts | Check if vulnerability alerts are enabled for a repository
+*ReposApi* | [**repos/codeownersErrors**](Apis/ReposApi.http#repos/codeownerserrors) | **GET** /repos/{owner}/{repo}/codeowners/errors | List CODEOWNERS errors
+*ReposApi* | [**repos/compareCommits**](Apis/ReposApi.http#repos/comparecommits) | **GET** /repos/{owner}/{repo}/compare/{basehead} | Compare two commits
+*ReposApi* | [**repos/createAutolink**](Apis/ReposApi.http#repos/createautolink) | **POST** /repos/{owner}/{repo}/autolinks | Create an autolink reference for a repository
+*ReposApi* | [**repos/createCommitComment**](Apis/ReposApi.http#repos/createcommitcomment) | **POST** /repos/{owner}/{repo}/commits/{commit_sha}/comments | Create a commit comment
+*ReposApi* | [**repos/createCommitSignatureProtection**](Apis/ReposApi.http#repos/createcommitsignatureprotection) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures | Create commit signature protection
+*ReposApi* | [**repos/createCommitStatus**](Apis/ReposApi.http#repos/createcommitstatus) | **POST** /repos/{owner}/{repo}/statuses/{sha} | Create a commit status
+*ReposApi* | [**repos/createDeployKey**](Apis/ReposApi.http#repos/createdeploykey) | **POST** /repos/{owner}/{repo}/keys | Create a deploy key
+*ReposApi* | [**repos/createDeployment**](Apis/ReposApi.http#repos/createdeployment) | **POST** /repos/{owner}/{repo}/deployments | Create a deployment
+*ReposApi* | [**repos/createDeploymentBranchPolicy**](Apis/ReposApi.http#repos/createdeploymentbranchpolicy) | **POST** /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies | Create a deployment branch policy
+*ReposApi* | [**repos/createDeploymentProtectionRule**](Apis/ReposApi.http#repos/createdeploymentprotectionrule) | **POST** /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules | Create a custom deployment protection rule on an environment
+*ReposApi* | [**repos/createDeploymentStatus**](Apis/ReposApi.http#repos/createdeploymentstatus) | **POST** /repos/{owner}/{repo}/deployments/{deployment_id}/statuses | Create a deployment status
+*ReposApi* | [**repos/createDispatchEvent**](Apis/ReposApi.http#repos/createdispatchevent) | **POST** /repos/{owner}/{repo}/dispatches | Create a repository dispatch event
+*ReposApi* | [**repos/createForAuthenticatedUser**](Apis/ReposApi.http#repos/createforauthenticateduser) | **POST** /user/repos | Create a repository for the authenticated user
+*ReposApi* | [**repos/createFork**](Apis/ReposApi.http#repos/createfork) | **POST** /repos/{owner}/{repo}/forks | Create a fork
+*ReposApi* | [**repos/createInOrg**](Apis/ReposApi.http#repos/createinorg) | **POST** /orgs/{org}/repos | Create an organization repository
+*ReposApi* | [**repos/createOrUpdateCustomPropertiesValues**](Apis/ReposApi.http#repos/createorupdatecustompropertiesvalues) | **PATCH** /repos/{owner}/{repo}/properties/values | Create or update custom property values for a repository
+*ReposApi* | [**repos/createOrUpdateEnvironment**](Apis/ReposApi.http#repos/createorupdateenvironment) | **PUT** /repos/{owner}/{repo}/environments/{environment_name} | Create or update an environment
+*ReposApi* | [**repos/createOrUpdateFileContents**](Apis/ReposApi.http#repos/createorupdatefilecontents) | **PUT** /repos/{owner}/{repo}/contents/{path} | Create or update file contents
+*ReposApi* | [**repos/createOrgRuleset**](Apis/ReposApi.http#repos/createorgruleset) | **POST** /orgs/{org}/rulesets | Create an organization repository ruleset
+*ReposApi* | [**repos/createPagesDeployment**](Apis/ReposApi.http#repos/createpagesdeployment) | **POST** /repos/{owner}/{repo}/pages/deployments | Create a GitHub Pages deployment
+*ReposApi* | [**repos/createPagesSite**](Apis/ReposApi.http#repos/createpagessite) | **POST** /repos/{owner}/{repo}/pages | Create a GitHub Pages site
+*ReposApi* | [**repos/createRelease**](Apis/ReposApi.http#repos/createrelease) | **POST** /repos/{owner}/{repo}/releases | Create a release
+*ReposApi* | [**repos/createRepoRuleset**](Apis/ReposApi.http#repos/createreporuleset) | **POST** /repos/{owner}/{repo}/rulesets | Create a repository ruleset
+*ReposApi* | [**repos/createTagProtection**](Apis/ReposApi.http#repos/createtagprotection) | **POST** /repos/{owner}/{repo}/tags/protection | Create a tag protection state for a repository
+*ReposApi* | [**repos/createUsingTemplate**](Apis/ReposApi.http#repos/createusingtemplate) | **POST** /repos/{template_owner}/{template_repo}/generate | Create a repository using a template
+*ReposApi* | [**repos/createWebhook**](Apis/ReposApi.http#repos/createwebhook) | **POST** /repos/{owner}/{repo}/hooks | Create a repository webhook
+*ReposApi* | [**repos/declineInvitationForAuthenticatedUser**](Apis/ReposApi.http#repos/declineinvitationforauthenticateduser) | **DELETE** /user/repository_invitations/{invitation_id} | Decline a repository invitation
+*ReposApi* | [**repos/delete**](Apis/ReposApi.http#repos/delete) | **DELETE** /repos/{owner}/{repo} | Delete a repository
+*ReposApi* | [**repos/deleteAccessRestrictions**](Apis/ReposApi.http#repos/deleteaccessrestrictions) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions | Delete access restrictions
+*ReposApi* | [**repos/deleteAdminBranchProtection**](Apis/ReposApi.http#repos/deleteadminbranchprotection) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins | Delete admin branch protection
+*ReposApi* | [**repos/deleteAnEnvironment**](Apis/ReposApi.http#repos/deleteanenvironment) | **DELETE** /repos/{owner}/{repo}/environments/{environment_name} | Delete an environment
+*ReposApi* | [**repos/deleteAutolink**](Apis/ReposApi.http#repos/deleteautolink) | **DELETE** /repos/{owner}/{repo}/autolinks/{autolink_id} | Delete an autolink reference from a repository
+*ReposApi* | [**repos/deleteBranchProtection**](Apis/ReposApi.http#repos/deletebranchprotection) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection | Delete branch protection
+*ReposApi* | [**repos/deleteCommitComment**](Apis/ReposApi.http#repos/deletecommitcomment) | **DELETE** /repos/{owner}/{repo}/comments/{comment_id} | Delete a commit comment
+*ReposApi* | [**repos/deleteCommitSignatureProtection**](Apis/ReposApi.http#repos/deletecommitsignatureprotection) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures | Delete commit signature protection
+*ReposApi* | [**repos/deleteDeployKey**](Apis/ReposApi.http#repos/deletedeploykey) | **DELETE** /repos/{owner}/{repo}/keys/{key_id} | Delete a deploy key
+*ReposApi* | [**repos/deleteDeployment**](Apis/ReposApi.http#repos/deletedeployment) | **DELETE** /repos/{owner}/{repo}/deployments/{deployment_id} | Delete a deployment
+*ReposApi* | [**repos/deleteDeploymentBranchPolicy**](Apis/ReposApi.http#repos/deletedeploymentbranchpolicy) | **DELETE** /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id} | Delete a deployment branch policy
+*ReposApi* | [**repos/deleteFile**](Apis/ReposApi.http#repos/deletefile) | **DELETE** /repos/{owner}/{repo}/contents/{path} | Delete a file
+*ReposApi* | [**repos/deleteInvitation**](Apis/ReposApi.http#repos/deleteinvitation) | **DELETE** /repos/{owner}/{repo}/invitations/{invitation_id} | Delete a repository invitation
+*ReposApi* | [**repos/deleteOrgRuleset**](Apis/ReposApi.http#repos/deleteorgruleset) | **DELETE** /orgs/{org}/rulesets/{ruleset_id} | Delete an organization repository ruleset
+*ReposApi* | [**repos/deletePagesSite**](Apis/ReposApi.http#repos/deletepagessite) | **DELETE** /repos/{owner}/{repo}/pages | Delete a GitHub Pages site
+*ReposApi* | [**repos/deletePullRequestReviewProtection**](Apis/ReposApi.http#repos/deletepullrequestreviewprotection) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews | Delete pull request review protection
+*ReposApi* | [**repos/deleteRelease**](Apis/ReposApi.http#repos/deleterelease) | **DELETE** /repos/{owner}/{repo}/releases/{release_id} | Delete a release
+*ReposApi* | [**repos/deleteReleaseAsset**](Apis/ReposApi.http#repos/deletereleaseasset) | **DELETE** /repos/{owner}/{repo}/releases/assets/{asset_id} | Delete a release asset
+*ReposApi* | [**repos/deleteRepoRuleset**](Apis/ReposApi.http#repos/deletereporuleset) | **DELETE** /repos/{owner}/{repo}/rulesets/{ruleset_id} | Delete a repository ruleset
+*ReposApi* | [**repos/deleteTagProtection**](Apis/ReposApi.http#repos/deletetagprotection) | **DELETE** /repos/{owner}/{repo}/tags/protection/{tag_protection_id} | Delete a tag protection state for a repository
+*ReposApi* | [**repos/deleteWebhook**](Apis/ReposApi.http#repos/deletewebhook) | **DELETE** /repos/{owner}/{repo}/hooks/{hook_id} | Delete a repository webhook
+*ReposApi* | [**repos/disableAutomatedSecurityFixes**](Apis/ReposApi.http#repos/disableautomatedsecurityfixes) | **DELETE** /repos/{owner}/{repo}/automated-security-fixes | Disable automated security fixes
+*ReposApi* | [**repos/disableDeploymentProtectionRule**](Apis/ReposApi.http#repos/disabledeploymentprotectionrule) | **DELETE** /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id} | Disable a custom protection rule for an environment
+*ReposApi* | [**repos/disablePrivateVulnerabilityReporting**](Apis/ReposApi.http#repos/disableprivatevulnerabilityreporting) | **DELETE** /repos/{owner}/{repo}/private-vulnerability-reporting | Disable private vulnerability reporting for a repository
+*ReposApi* | [**repos/disableVulnerabilityAlerts**](Apis/ReposApi.http#repos/disablevulnerabilityalerts) | **DELETE** /repos/{owner}/{repo}/vulnerability-alerts | Disable vulnerability alerts
+*ReposApi* | [**repos/downloadTarballArchive**](Apis/ReposApi.http#repos/downloadtarballarchive) | **GET** /repos/{owner}/{repo}/tarball/{ref} | Download a repository archive (tar)
+*ReposApi* | [**repos/downloadZipballArchive**](Apis/ReposApi.http#repos/downloadzipballarchive) | **GET** /repos/{owner}/{repo}/zipball/{ref} | Download a repository archive (zip)
+*ReposApi* | [**repos/enableAutomatedSecurityFixes**](Apis/ReposApi.http#repos/enableautomatedsecurityfixes) | **PUT** /repos/{owner}/{repo}/automated-security-fixes | Enable automated security fixes
+*ReposApi* | [**repos/enablePrivateVulnerabilityReporting**](Apis/ReposApi.http#repos/enableprivatevulnerabilityreporting) | **PUT** /repos/{owner}/{repo}/private-vulnerability-reporting | Enable private vulnerability reporting for a repository
+*ReposApi* | [**repos/enableVulnerabilityAlerts**](Apis/ReposApi.http#repos/enablevulnerabilityalerts) | **PUT** /repos/{owner}/{repo}/vulnerability-alerts | Enable vulnerability alerts
+*ReposApi* | [**repos/generateReleaseNotes**](Apis/ReposApi.http#repos/generatereleasenotes) | **POST** /repos/{owner}/{repo}/releases/generate-notes | Generate release notes content for a release
+*ReposApi* | [**repos/get**](Apis/ReposApi.http#repos/get) | **GET** /repos/{owner}/{repo} | Get a repository
+*ReposApi* | [**repos/getAccessRestrictions**](Apis/ReposApi.http#repos/getaccessrestrictions) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions | Get access restrictions
+*ReposApi* | [**repos/getAdminBranchProtection**](Apis/ReposApi.http#repos/getadminbranchprotection) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins | Get admin branch protection
+*ReposApi* | [**repos/getAllDeploymentProtectionRules**](Apis/ReposApi.http#repos/getalldeploymentprotectionrules) | **GET** /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules | Get all deployment protection rules for an environment
+*ReposApi* | [**repos/getAllEnvironments**](Apis/ReposApi.http#repos/getallenvironments) | **GET** /repos/{owner}/{repo}/environments | List environments
+*ReposApi* | [**repos/getAllStatusCheckContexts**](Apis/ReposApi.http#repos/getallstatuscheckcontexts) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts | Get all status check contexts
+*ReposApi* | [**repos/getAllTopics**](Apis/ReposApi.http#repos/getalltopics) | **GET** /repos/{owner}/{repo}/topics | Get all repository topics
+*ReposApi* | [**repos/getAppsWithAccessToProtectedBranch**](Apis/ReposApi.http#repos/getappswithaccesstoprotectedbranch) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps | Get apps with access to the protected branch
+*ReposApi* | [**repos/getAutolink**](Apis/ReposApi.http#repos/getautolink) | **GET** /repos/{owner}/{repo}/autolinks/{autolink_id} | Get an autolink reference of a repository
+*ReposApi* | [**repos/getBranch**](Apis/ReposApi.http#repos/getbranch) | **GET** /repos/{owner}/{repo}/branches/{branch} | Get a branch
+*ReposApi* | [**repos/getBranchProtection**](Apis/ReposApi.http#repos/getbranchprotection) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection | Get branch protection
+*ReposApi* | [**repos/getBranchRules**](Apis/ReposApi.http#repos/getbranchrules) | **GET** /repos/{owner}/{repo}/rules/branches/{branch} | Get rules for a branch
+*ReposApi* | [**repos/getClones**](Apis/ReposApi.http#repos/getclones) | **GET** /repos/{owner}/{repo}/traffic/clones | Get repository clones
+*ReposApi* | [**repos/getCodeFrequencyStats**](Apis/ReposApi.http#repos/getcodefrequencystats) | **GET** /repos/{owner}/{repo}/stats/code_frequency | Get the weekly commit activity
+*ReposApi* | [**repos/getCollaboratorPermissionLevel**](Apis/ReposApi.http#repos/getcollaboratorpermissionlevel) | **GET** /repos/{owner}/{repo}/collaborators/{username}/permission | Get repository permissions for a user
+*ReposApi* | [**repos/getCombinedStatusForRef**](Apis/ReposApi.http#repos/getcombinedstatusforref) | **GET** /repos/{owner}/{repo}/commits/{ref}/status | Get the combined status for a specific reference
+*ReposApi* | [**repos/getCommit**](Apis/ReposApi.http#repos/getcommit) | **GET** /repos/{owner}/{repo}/commits/{ref} | Get a commit
+*ReposApi* | [**repos/getCommitActivityStats**](Apis/ReposApi.http#repos/getcommitactivitystats) | **GET** /repos/{owner}/{repo}/stats/commit_activity | Get the last year of commit activity
+*ReposApi* | [**repos/getCommitComment**](Apis/ReposApi.http#repos/getcommitcomment) | **GET** /repos/{owner}/{repo}/comments/{comment_id} | Get a commit comment
+*ReposApi* | [**repos/getCommitSignatureProtection**](Apis/ReposApi.http#repos/getcommitsignatureprotection) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures | Get commit signature protection
+*ReposApi* | [**repos/getCommunityProfileMetrics**](Apis/ReposApi.http#repos/getcommunityprofilemetrics) | **GET** /repos/{owner}/{repo}/community/profile | Get community profile metrics
+*ReposApi* | [**repos/getContent**](Apis/ReposApi.http#repos/getcontent) | **GET** /repos/{owner}/{repo}/contents/{path} | Get repository content
+*ReposApi* | [**repos/getContributorsStats**](Apis/ReposApi.http#repos/getcontributorsstats) | **GET** /repos/{owner}/{repo}/stats/contributors | Get all contributor commit activity
+*ReposApi* | [**repos/getCustomDeploymentProtectionRule**](Apis/ReposApi.http#repos/getcustomdeploymentprotectionrule) | **GET** /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id} | Get a custom deployment protection rule
+*ReposApi* | [**repos/getCustomPropertiesValues**](Apis/ReposApi.http#repos/getcustompropertiesvalues) | **GET** /repos/{owner}/{repo}/properties/values | Get all custom property values for a repository
+*ReposApi* | [**repos/getDeployKey**](Apis/ReposApi.http#repos/getdeploykey) | **GET** /repos/{owner}/{repo}/keys/{key_id} | Get a deploy key
+*ReposApi* | [**repos/getDeployment**](Apis/ReposApi.http#repos/getdeployment) | **GET** /repos/{owner}/{repo}/deployments/{deployment_id} | Get a deployment
+*ReposApi* | [**repos/getDeploymentBranchPolicy**](Apis/ReposApi.http#repos/getdeploymentbranchpolicy) | **GET** /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id} | Get a deployment branch policy
+*ReposApi* | [**repos/getDeploymentStatus**](Apis/ReposApi.http#repos/getdeploymentstatus) | **GET** /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id} | Get a deployment status
+*ReposApi* | [**repos/getEnvironment**](Apis/ReposApi.http#repos/getenvironment) | **GET** /repos/{owner}/{repo}/environments/{environment_name} | Get an environment
+*ReposApi* | [**repos/getLatestPagesBuild**](Apis/ReposApi.http#repos/getlatestpagesbuild) | **GET** /repos/{owner}/{repo}/pages/builds/latest | Get latest Pages build
+*ReposApi* | [**repos/getLatestRelease**](Apis/ReposApi.http#repos/getlatestrelease) | **GET** /repos/{owner}/{repo}/releases/latest | Get the latest release
+*ReposApi* | [**repos/getOrgRuleSuite**](Apis/ReposApi.http#repos/getorgrulesuite) | **GET** /orgs/{org}/rulesets/rule-suites/{rule_suite_id} | Get an organization rule suite
+*ReposApi* | [**repos/getOrgRuleSuites**](Apis/ReposApi.http#repos/getorgrulesuites) | **GET** /orgs/{org}/rulesets/rule-suites | List organization rule suites
+*ReposApi* | [**repos/getOrgRuleset**](Apis/ReposApi.http#repos/getorgruleset) | **GET** /orgs/{org}/rulesets/{ruleset_id} | Get an organization repository ruleset
+*ReposApi* | [**repos/getOrgRulesets**](Apis/ReposApi.http#repos/getorgrulesets) | **GET** /orgs/{org}/rulesets | Get all organization repository rulesets
+*ReposApi* | [**repos/getPages**](Apis/ReposApi.http#repos/getpages) | **GET** /repos/{owner}/{repo}/pages | Get a GitHub Pages site
+*ReposApi* | [**repos/getPagesBuild**](Apis/ReposApi.http#repos/getpagesbuild) | **GET** /repos/{owner}/{repo}/pages/builds/{build_id} | Get GitHub Pages build
+*ReposApi* | [**repos/getPagesDeployment**](Apis/ReposApi.http#repos/getpagesdeployment) | **GET** /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id} | Get the status of a GitHub Pages deployment
+*ReposApi* | [**repos/getPagesHealthCheck**](Apis/ReposApi.http#repos/getpageshealthcheck) | **GET** /repos/{owner}/{repo}/pages/health | Get a DNS health check for GitHub Pages
+*ReposApi* | [**repos/getParticipationStats**](Apis/ReposApi.http#repos/getparticipationstats) | **GET** /repos/{owner}/{repo}/stats/participation | Get the weekly commit count
+*ReposApi* | [**repos/getPullRequestReviewProtection**](Apis/ReposApi.http#repos/getpullrequestreviewprotection) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews | Get pull request review protection
+*ReposApi* | [**repos/getPunchCardStats**](Apis/ReposApi.http#repos/getpunchcardstats) | **GET** /repos/{owner}/{repo}/stats/punch_card | Get the hourly commit count for each day
+*ReposApi* | [**repos/getReadme**](Apis/ReposApi.http#repos/getreadme) | **GET** /repos/{owner}/{repo}/readme | Get a repository README
+*ReposApi* | [**repos/getReadmeInDirectory**](Apis/ReposApi.http#repos/getreadmeindirectory) | **GET** /repos/{owner}/{repo}/readme/{dir} | Get a repository README for a directory
+*ReposApi* | [**repos/getRelease**](Apis/ReposApi.http#repos/getrelease) | **GET** /repos/{owner}/{repo}/releases/{release_id} | Get a release
+*ReposApi* | [**repos/getReleaseAsset**](Apis/ReposApi.http#repos/getreleaseasset) | **GET** /repos/{owner}/{repo}/releases/assets/{asset_id} | Get a release asset
+*ReposApi* | [**repos/getReleaseByTag**](Apis/ReposApi.http#repos/getreleasebytag) | **GET** /repos/{owner}/{repo}/releases/tags/{tag} | Get a release by tag name
+*ReposApi* | [**repos/getRepoRuleSuite**](Apis/ReposApi.http#repos/getreporulesuite) | **GET** /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id} | Get a repository rule suite
+*ReposApi* | [**repos/getRepoRuleSuites**](Apis/ReposApi.http#repos/getreporulesuites) | **GET** /repos/{owner}/{repo}/rulesets/rule-suites | List repository rule suites
+*ReposApi* | [**repos/getRepoRuleset**](Apis/ReposApi.http#repos/getreporuleset) | **GET** /repos/{owner}/{repo}/rulesets/{ruleset_id} | Get a repository ruleset
+*ReposApi* | [**repos/getRepoRulesets**](Apis/ReposApi.http#repos/getreporulesets) | **GET** /repos/{owner}/{repo}/rulesets | Get all repository rulesets
+*ReposApi* | [**repos/getStatusChecksProtection**](Apis/ReposApi.http#repos/getstatuschecksprotection) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks | Get status checks protection
+*ReposApi* | [**repos/getTeamsWithAccessToProtectedBranch**](Apis/ReposApi.http#repos/getteamswithaccesstoprotectedbranch) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams | Get teams with access to the protected branch
+*ReposApi* | [**repos/getTopPaths**](Apis/ReposApi.http#repos/gettoppaths) | **GET** /repos/{owner}/{repo}/traffic/popular/paths | Get top referral paths
+*ReposApi* | [**repos/getTopReferrers**](Apis/ReposApi.http#repos/gettopreferrers) | **GET** /repos/{owner}/{repo}/traffic/popular/referrers | Get top referral sources
+*ReposApi* | [**repos/getUsersWithAccessToProtectedBranch**](Apis/ReposApi.http#repos/getuserswithaccesstoprotectedbranch) | **GET** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users | Get users with access to the protected branch
+*ReposApi* | [**repos/getViews**](Apis/ReposApi.http#repos/getviews) | **GET** /repos/{owner}/{repo}/traffic/views | Get page views
+*ReposApi* | [**repos/getWebhook**](Apis/ReposApi.http#repos/getwebhook) | **GET** /repos/{owner}/{repo}/hooks/{hook_id} | Get a repository webhook
+*ReposApi* | [**repos/getWebhookConfigForRepo**](Apis/ReposApi.http#repos/getwebhookconfigforrepo) | **GET** /repos/{owner}/{repo}/hooks/{hook_id}/config | Get a webhook configuration for a repository
+*ReposApi* | [**repos/getWebhookDelivery**](Apis/ReposApi.http#repos/getwebhookdelivery) | **GET** /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id} | Get a delivery for a repository webhook
+*ReposApi* | [**repos/listActivities**](Apis/ReposApi.http#repos/listactivities) | **GET** /repos/{owner}/{repo}/activity | List repository activities
+*ReposApi* | [**repos/listAutolinks**](Apis/ReposApi.http#repos/listautolinks) | **GET** /repos/{owner}/{repo}/autolinks | Get all autolinks of a repository
+*ReposApi* | [**repos/listBranches**](Apis/ReposApi.http#repos/listbranches) | **GET** /repos/{owner}/{repo}/branches | List branches
+*ReposApi* | [**repos/listBranchesForHeadCommit**](Apis/ReposApi.http#repos/listbranchesforheadcommit) | **GET** /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head | List branches for HEAD commit
+*ReposApi* | [**repos/listCollaborators**](Apis/ReposApi.http#repos/listcollaborators) | **GET** /repos/{owner}/{repo}/collaborators | List repository collaborators
+*ReposApi* | [**repos/listCommentsForCommit**](Apis/ReposApi.http#repos/listcommentsforcommit) | **GET** /repos/{owner}/{repo}/commits/{commit_sha}/comments | List commit comments
+*ReposApi* | [**repos/listCommitCommentsForRepo**](Apis/ReposApi.http#repos/listcommitcommentsforrepo) | **GET** /repos/{owner}/{repo}/comments | List commit comments for a repository
+*ReposApi* | [**repos/listCommitStatusesForRef**](Apis/ReposApi.http#repos/listcommitstatusesforref) | **GET** /repos/{owner}/{repo}/commits/{ref}/statuses | List commit statuses for a reference
+*ReposApi* | [**repos/listCommits**](Apis/ReposApi.http#repos/listcommits) | **GET** /repos/{owner}/{repo}/commits | List commits
+*ReposApi* | [**repos/listContributors**](Apis/ReposApi.http#repos/listcontributors) | **GET** /repos/{owner}/{repo}/contributors | List repository contributors
+*ReposApi* | [**repos/listCustomDeploymentRuleIntegrations**](Apis/ReposApi.http#repos/listcustomdeploymentruleintegrations) | **GET** /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps | List custom deployment rule integrations available for an environment
+*ReposApi* | [**repos/listDeployKeys**](Apis/ReposApi.http#repos/listdeploykeys) | **GET** /repos/{owner}/{repo}/keys | List deploy keys
+*ReposApi* | [**repos/listDeploymentBranchPolicies**](Apis/ReposApi.http#repos/listdeploymentbranchpolicies) | **GET** /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies | List deployment branch policies
+*ReposApi* | [**repos/listDeploymentStatuses**](Apis/ReposApi.http#repos/listdeploymentstatuses) | **GET** /repos/{owner}/{repo}/deployments/{deployment_id}/statuses | List deployment statuses
+*ReposApi* | [**repos/listDeployments**](Apis/ReposApi.http#repos/listdeployments) | **GET** /repos/{owner}/{repo}/deployments | List deployments
+*ReposApi* | [**repos/listForAuthenticatedUser**](Apis/ReposApi.http#repos/listforauthenticateduser) | **GET** /user/repos | List repositories for the authenticated user
+*ReposApi* | [**repos/listForOrg**](Apis/ReposApi.http#repos/listfororg) | **GET** /orgs/{org}/repos | List organization repositories
+*ReposApi* | [**repos/listForUser**](Apis/ReposApi.http#repos/listforuser) | **GET** /users/{username}/repos | List repositories for a user
+*ReposApi* | [**repos/listForks**](Apis/ReposApi.http#repos/listforks) | **GET** /repos/{owner}/{repo}/forks | List forks
+*ReposApi* | [**repos/listInvitations**](Apis/ReposApi.http#repos/listinvitations) | **GET** /repos/{owner}/{repo}/invitations | List repository invitations
+*ReposApi* | [**repos/listInvitationsForAuthenticatedUser**](Apis/ReposApi.http#repos/listinvitationsforauthenticateduser) | **GET** /user/repository_invitations | List repository invitations for the authenticated user
+*ReposApi* | [**repos/listLanguages**](Apis/ReposApi.http#repos/listlanguages) | **GET** /repos/{owner}/{repo}/languages | List repository languages
+*ReposApi* | [**repos/listPagesBuilds**](Apis/ReposApi.http#repos/listpagesbuilds) | **GET** /repos/{owner}/{repo}/pages/builds | List GitHub Pages builds
+*ReposApi* | [**repos/listPublic**](Apis/ReposApi.http#repos/listpublic) | **GET** /repositories | List public repositories
+*ReposApi* | [**repos/listPullRequestsAssociatedWithCommit**](Apis/ReposApi.http#repos/listpullrequestsassociatedwithcommit) | **GET** /repos/{owner}/{repo}/commits/{commit_sha}/pulls | List pull requests associated with a commit
+*ReposApi* | [**repos/listReleaseAssets**](Apis/ReposApi.http#repos/listreleaseassets) | **GET** /repos/{owner}/{repo}/releases/{release_id}/assets | List release assets
+*ReposApi* | [**repos/listReleases**](Apis/ReposApi.http#repos/listreleases) | **GET** /repos/{owner}/{repo}/releases | List releases
+*ReposApi* | [**repos/listTagProtection**](Apis/ReposApi.http#repos/listtagprotection) | **GET** /repos/{owner}/{repo}/tags/protection | List tag protection states for a repository
+*ReposApi* | [**repos/listTags**](Apis/ReposApi.http#repos/listtags) | **GET** /repos/{owner}/{repo}/tags | List repository tags
+*ReposApi* | [**repos/listTeams**](Apis/ReposApi.http#repos/listteams) | **GET** /repos/{owner}/{repo}/teams | List repository teams
+*ReposApi* | [**repos/listWebhookDeliveries**](Apis/ReposApi.http#repos/listwebhookdeliveries) | **GET** /repos/{owner}/{repo}/hooks/{hook_id}/deliveries | List deliveries for a repository webhook
+*ReposApi* | [**repos/listWebhooks**](Apis/ReposApi.http#repos/listwebhooks) | **GET** /repos/{owner}/{repo}/hooks | List repository webhooks
+*ReposApi* | [**repos/merge**](Apis/ReposApi.http#repos/merge) | **POST** /repos/{owner}/{repo}/merges | Merge a branch
+*ReposApi* | [**repos/mergeUpstream**](Apis/ReposApi.http#repos/mergeupstream) | **POST** /repos/{owner}/{repo}/merge-upstream | Sync a fork branch with the upstream repository
+*ReposApi* | [**repos/pingWebhook**](Apis/ReposApi.http#repos/pingwebhook) | **POST** /repos/{owner}/{repo}/hooks/{hook_id}/pings | Ping a repository webhook
+*ReposApi* | [**repos/redeliverWebhookDelivery**](Apis/ReposApi.http#repos/redeliverwebhookdelivery) | **POST** /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts | Redeliver a delivery for a repository webhook
+*ReposApi* | [**repos/removeAppAccessRestrictions**](Apis/ReposApi.http#repos/removeappaccessrestrictions) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps | Remove app access restrictions
+*ReposApi* | [**repos/removeCollaborator**](Apis/ReposApi.http#repos/removecollaborator) | **DELETE** /repos/{owner}/{repo}/collaborators/{username} | Remove a repository collaborator
+*ReposApi* | [**repos/removeStatusCheckContexts**](Apis/ReposApi.http#repos/removestatuscheckcontexts) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts | Remove status check contexts
+*ReposApi* | [**repos/removeStatusCheckProtection**](Apis/ReposApi.http#repos/removestatuscheckprotection) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks | Remove status check protection
+*ReposApi* | [**repos/removeTeamAccessRestrictions**](Apis/ReposApi.http#repos/removeteamaccessrestrictions) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams | Remove team access restrictions
+*ReposApi* | [**repos/removeUserAccessRestrictions**](Apis/ReposApi.http#repos/removeuseraccessrestrictions) | **DELETE** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users | Remove user access restrictions
+*ReposApi* | [**repos/renameBranch**](Apis/ReposApi.http#repos/renamebranch) | **POST** /repos/{owner}/{repo}/branches/{branch}/rename | Rename a branch
+*ReposApi* | [**repos/replaceAllTopics**](Apis/ReposApi.http#repos/replacealltopics) | **PUT** /repos/{owner}/{repo}/topics | Replace all repository topics
+*ReposApi* | [**repos/requestPagesBuild**](Apis/ReposApi.http#repos/requestpagesbuild) | **POST** /repos/{owner}/{repo}/pages/builds | Request a GitHub Pages build
+*ReposApi* | [**repos/setAdminBranchProtection**](Apis/ReposApi.http#repos/setadminbranchprotection) | **POST** /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins | Set admin branch protection
+*ReposApi* | [**repos/setAppAccessRestrictions**](Apis/ReposApi.http#repos/setappaccessrestrictions) | **PUT** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps | Set app access restrictions
+*ReposApi* | [**repos/setStatusCheckContexts**](Apis/ReposApi.http#repos/setstatuscheckcontexts) | **PUT** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts | Set status check contexts
+*ReposApi* | [**repos/setTeamAccessRestrictions**](Apis/ReposApi.http#repos/setteamaccessrestrictions) | **PUT** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams | Set team access restrictions
+*ReposApi* | [**repos/setUserAccessRestrictions**](Apis/ReposApi.http#repos/setuseraccessrestrictions) | **PUT** /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users | Set user access restrictions
+*ReposApi* | [**repos/testPushWebhook**](Apis/ReposApi.http#repos/testpushwebhook) | **POST** /repos/{owner}/{repo}/hooks/{hook_id}/tests | Test the push repository webhook
+*ReposApi* | [**repos/transfer**](Apis/ReposApi.http#repos/transfer) | **POST** /repos/{owner}/{repo}/transfer | Transfer a repository
+*ReposApi* | [**repos/update**](Apis/ReposApi.http#repos/update) | **PATCH** /repos/{owner}/{repo} | Update a repository
+*ReposApi* | [**repos/updateBranchProtection**](Apis/ReposApi.http#repos/updatebranchprotection) | **PUT** /repos/{owner}/{repo}/branches/{branch}/protection | Update branch protection
+*ReposApi* | [**repos/updateCommitComment**](Apis/ReposApi.http#repos/updatecommitcomment) | **PATCH** /repos/{owner}/{repo}/comments/{comment_id} | Update a commit comment
+*ReposApi* | [**repos/updateDeploymentBranchPolicy**](Apis/ReposApi.http#repos/updatedeploymentbranchpolicy) | **PUT** /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id} | Update a deployment branch policy
+*ReposApi* | [**repos/updateInformationAboutPagesSite**](Apis/ReposApi.http#repos/updateinformationaboutpagessite) | **PUT** /repos/{owner}/{repo}/pages | Update information about a GitHub Pages site
+*ReposApi* | [**repos/updateInvitation**](Apis/ReposApi.http#repos/updateinvitation) | **PATCH** /repos/{owner}/{repo}/invitations/{invitation_id} | Update a repository invitation
+*ReposApi* | [**repos/updateOrgRuleset**](Apis/ReposApi.http#repos/updateorgruleset) | **PUT** /orgs/{org}/rulesets/{ruleset_id} | Update an organization repository ruleset
+*ReposApi* | [**repos/updatePullRequestReviewProtection**](Apis/ReposApi.http#repos/updatepullrequestreviewprotection) | **PATCH** /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews | Update pull request review protection
+*ReposApi* | [**repos/updateRelease**](Apis/ReposApi.http#repos/updaterelease) | **PATCH** /repos/{owner}/{repo}/releases/{release_id} | Update a release
+*ReposApi* | [**repos/updateReleaseAsset**](Apis/ReposApi.http#repos/updatereleaseasset) | **PATCH** /repos/{owner}/{repo}/releases/assets/{asset_id} | Update a release asset
+*ReposApi* | [**repos/updateRepoRuleset**](Apis/ReposApi.http#repos/updatereporuleset) | **PUT** /repos/{owner}/{repo}/rulesets/{ruleset_id} | Update a repository ruleset
+*ReposApi* | [**repos/updateStatusCheckProtection**](Apis/ReposApi.http#repos/updatestatuscheckprotection) | **PATCH** /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks | Update status check protection
+*ReposApi* | [**repos/updateWebhook**](Apis/ReposApi.http#repos/updatewebhook) | **PATCH** /repos/{owner}/{repo}/hooks/{hook_id} | Update a repository webhook
+*ReposApi* | [**repos/updateWebhookConfigForRepo**](Apis/ReposApi.http#repos/updatewebhookconfigforrepo) | **PATCH** /repos/{owner}/{repo}/hooks/{hook_id}/config | Update a webhook configuration for a repository
+*ReposApi* | [**repos/uploadReleaseAsset**](Apis/ReposApi.http#repos/uploadreleaseasset) | **POST** /repos/{owner}/{repo}/releases/{release_id}/assets | Upload a release asset
+*SearchApi* | [**search/code**](Apis/SearchApi.http#search/code) | **GET** /search/code | Search code
+*SearchApi* | [**search/commits**](Apis/SearchApi.http#search/commits) | **GET** /search/commits | Search commits
+*SearchApi* | [**search/issuesAndPullRequests**](Apis/SearchApi.http#search/issuesandpullrequests) | **GET** /search/issues | Search issues and pull requests
+*SearchApi* | [**search/labels**](Apis/SearchApi.http#search/labels) | **GET** /search/labels | Search labels
+*SearchApi* | [**search/repos**](Apis/SearchApi.http#search/repos) | **GET** /search/repositories | Search repositories
+*SearchApi* | [**search/topics**](Apis/SearchApi.http#search/topics) | **GET** /search/topics | Search topics
+*SearchApi* | [**search/users**](Apis/SearchApi.http#search/users) | **GET** /search/users | Search users
+*SecretScanningApi* | [**secretScanning/getAlert**](Apis/SecretScanningApi.http#secretscanning/getalert) | **GET** /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number} | Get a secret scanning alert
+*SecretScanningApi* | [**secretScanning/listAlertsForEnterprise**](Apis/SecretScanningApi.http#secretscanning/listalertsforenterprise) | **GET** /enterprises/{enterprise}/secret-scanning/alerts | List secret scanning alerts for an enterprise
+*SecretScanningApi* | [**secretScanning/listAlertsForOrg**](Apis/SecretScanningApi.http#secretscanning/listalertsfororg) | **GET** /orgs/{org}/secret-scanning/alerts | List secret scanning alerts for an organization
+*SecretScanningApi* | [**secretScanning/listAlertsForRepo**](Apis/SecretScanningApi.http#secretscanning/listalertsforrepo) | **GET** /repos/{owner}/{repo}/secret-scanning/alerts | List secret scanning alerts for a repository
+*SecretScanningApi* | [**secretScanning/listLocationsForAlert**](Apis/SecretScanningApi.http#secretscanning/listlocationsforalert) | **GET** /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations | List locations for a secret scanning alert
+*SecretScanningApi* | [**secretScanning/updateAlert**](Apis/SecretScanningApi.http#secretscanning/updatealert) | **PATCH** /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number} | Update a secret scanning alert
+*SecurityAdvisoriesApi* | [**securityAdvisories/createFork**](Apis/SecurityAdvisoriesApi.http#securityadvisories/createfork) | **POST** /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks | Create a temporary private fork
+*SecurityAdvisoriesApi* | [**securityAdvisories/createPrivateVulnerabilityReport**](Apis/SecurityAdvisoriesApi.http#securityadvisories/createprivatevulnerabilityreport) | **POST** /repos/{owner}/{repo}/security-advisories/reports | Privately report a security vulnerability
+*SecurityAdvisoriesApi* | [**securityAdvisories/createRepositoryAdvisory**](Apis/SecurityAdvisoriesApi.http#securityadvisories/createrepositoryadvisory) | **POST** /repos/{owner}/{repo}/security-advisories | Create a repository security advisory
+*SecurityAdvisoriesApi* | [**securityAdvisories/createRepositoryAdvisoryCveRequest**](Apis/SecurityAdvisoriesApi.http#securityadvisories/createrepositoryadvisorycverequest) | **POST** /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve | Request a CVE for a repository security advisory
+*SecurityAdvisoriesApi* | [**securityAdvisories/getGlobalAdvisory**](Apis/SecurityAdvisoriesApi.http#securityadvisories/getglobaladvisory) | **GET** /advisories/{ghsa_id} | Get a global security advisory
+*SecurityAdvisoriesApi* | [**securityAdvisories/getRepositoryAdvisory**](Apis/SecurityAdvisoriesApi.http#securityadvisories/getrepositoryadvisory) | **GET** /repos/{owner}/{repo}/security-advisories/{ghsa_id} | Get a repository security advisory
+*SecurityAdvisoriesApi* | [**securityAdvisories/listGlobalAdvisories**](Apis/SecurityAdvisoriesApi.http#securityadvisories/listglobaladvisories) | **GET** /advisories | List global security advisories
+*SecurityAdvisoriesApi* | [**securityAdvisories/listOrgRepositoryAdvisories**](Apis/SecurityAdvisoriesApi.http#securityadvisories/listorgrepositoryadvisories) | **GET** /orgs/{org}/security-advisories | List repository security advisories for an organization
+*SecurityAdvisoriesApi* | [**securityAdvisories/listRepositoryAdvisories**](Apis/SecurityAdvisoriesApi.http#securityadvisories/listrepositoryadvisories) | **GET** /repos/{owner}/{repo}/security-advisories | List repository security advisories
+*SecurityAdvisoriesApi* | [**securityAdvisories/updateRepositoryAdvisory**](Apis/SecurityAdvisoriesApi.http#securityadvisories/updaterepositoryadvisory) | **PATCH** /repos/{owner}/{repo}/security-advisories/{ghsa_id} | Update a repository security advisory
+*TeamsApi* | [**teams/addMemberLegacy**](Apis/TeamsApi.http#teams/addmemberlegacy) | **PUT** /teams/{team_id}/members/{username} | Add team member (Legacy)
+*TeamsApi* | [**teams/addOrUpdateMembershipForUserInOrg**](Apis/TeamsApi.http#teams/addorupdatemembershipforuserinorg) | **PUT** /orgs/{org}/teams/{team_slug}/memberships/{username} | Add or update team membership for a user
+*TeamsApi* | [**teams/addOrUpdateMembershipForUserLegacy**](Apis/TeamsApi.http#teams/addorupdatemembershipforuserlegacy) | **PUT** /teams/{team_id}/memberships/{username} | Add or update team membership for a user (Legacy)
+*TeamsApi* | [**teams/addOrUpdateProjectPermissionsInOrg**](Apis/TeamsApi.http#teams/addorupdateprojectpermissionsinorg) | **PUT** /orgs/{org}/teams/{team_slug}/projects/{project_id} | Add or update team project permissions
+*TeamsApi* | [**teams/addOrUpdateProjectPermissionsLegacy**](Apis/TeamsApi.http#teams/addorupdateprojectpermissionslegacy) | **PUT** /teams/{team_id}/projects/{project_id} | Add or update team project permissions (Legacy)
+*TeamsApi* | [**teams/addOrUpdateRepoPermissionsInOrg**](Apis/TeamsApi.http#teams/addorupdaterepopermissionsinorg) | **PUT** /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} | Add or update team repository permissions
+*TeamsApi* | [**teams/addOrUpdateRepoPermissionsLegacy**](Apis/TeamsApi.http#teams/addorupdaterepopermissionslegacy) | **PUT** /teams/{team_id}/repos/{owner}/{repo} | Add or update team repository permissions (Legacy)
+*TeamsApi* | [**teams/checkPermissionsForProjectInOrg**](Apis/TeamsApi.http#teams/checkpermissionsforprojectinorg) | **GET** /orgs/{org}/teams/{team_slug}/projects/{project_id} | Check team permissions for a project
+*TeamsApi* | [**teams/checkPermissionsForProjectLegacy**](Apis/TeamsApi.http#teams/checkpermissionsforprojectlegacy) | **GET** /teams/{team_id}/projects/{project_id} | Check team permissions for a project (Legacy)
+*TeamsApi* | [**teams/checkPermissionsForRepoInOrg**](Apis/TeamsApi.http#teams/checkpermissionsforrepoinorg) | **GET** /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} | Check team permissions for a repository
+*TeamsApi* | [**teams/checkPermissionsForRepoLegacy**](Apis/TeamsApi.http#teams/checkpermissionsforrepolegacy) | **GET** /teams/{team_id}/repos/{owner}/{repo} | Check team permissions for a repository (Legacy)
+*TeamsApi* | [**teams/create**](Apis/TeamsApi.http#teams/create) | **POST** /orgs/{org}/teams | Create a team
+*TeamsApi* | [**teams/createDiscussionCommentInOrg**](Apis/TeamsApi.http#teams/creatediscussioncommentinorg) | **POST** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments | Create a discussion comment
+*TeamsApi* | [**teams/createDiscussionCommentLegacy**](Apis/TeamsApi.http#teams/creatediscussioncommentlegacy) | **POST** /teams/{team_id}/discussions/{discussion_number}/comments | Create a discussion comment (Legacy)
+*TeamsApi* | [**teams/createDiscussionInOrg**](Apis/TeamsApi.http#teams/creatediscussioninorg) | **POST** /orgs/{org}/teams/{team_slug}/discussions | Create a discussion
+*TeamsApi* | [**teams/createDiscussionLegacy**](Apis/TeamsApi.http#teams/creatediscussionlegacy) | **POST** /teams/{team_id}/discussions | Create a discussion (Legacy)
+*TeamsApi* | [**teams/deleteDiscussionCommentInOrg**](Apis/TeamsApi.http#teams/deletediscussioncommentinorg) | **DELETE** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number} | Delete a discussion comment
+*TeamsApi* | [**teams/deleteDiscussionCommentLegacy**](Apis/TeamsApi.http#teams/deletediscussioncommentlegacy) | **DELETE** /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number} | Delete a discussion comment (Legacy)
+*TeamsApi* | [**teams/deleteDiscussionInOrg**](Apis/TeamsApi.http#teams/deletediscussioninorg) | **DELETE** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number} | Delete a discussion
+*TeamsApi* | [**teams/deleteDiscussionLegacy**](Apis/TeamsApi.http#teams/deletediscussionlegacy) | **DELETE** /teams/{team_id}/discussions/{discussion_number} | Delete a discussion (Legacy)
+*TeamsApi* | [**teams/deleteInOrg**](Apis/TeamsApi.http#teams/deleteinorg) | **DELETE** /orgs/{org}/teams/{team_slug} | Delete a team
+*TeamsApi* | [**teams/deleteLegacy**](Apis/TeamsApi.http#teams/deletelegacy) | **DELETE** /teams/{team_id} | Delete a team (Legacy)
+*TeamsApi* | [**teams/getByName**](Apis/TeamsApi.http#teams/getbyname) | **GET** /orgs/{org}/teams/{team_slug} | Get a team by name
+*TeamsApi* | [**teams/getDiscussionCommentInOrg**](Apis/TeamsApi.http#teams/getdiscussioncommentinorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number} | Get a discussion comment
+*TeamsApi* | [**teams/getDiscussionCommentLegacy**](Apis/TeamsApi.http#teams/getdiscussioncommentlegacy) | **GET** /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number} | Get a discussion comment (Legacy)
+*TeamsApi* | [**teams/getDiscussionInOrg**](Apis/TeamsApi.http#teams/getdiscussioninorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number} | Get a discussion
+*TeamsApi* | [**teams/getDiscussionLegacy**](Apis/TeamsApi.http#teams/getdiscussionlegacy) | **GET** /teams/{team_id}/discussions/{discussion_number} | Get a discussion (Legacy)
+*TeamsApi* | [**teams/getLegacy**](Apis/TeamsApi.http#teams/getlegacy) | **GET** /teams/{team_id} | Get a team (Legacy)
+*TeamsApi* | [**teams/getMemberLegacy**](Apis/TeamsApi.http#teams/getmemberlegacy) | **GET** /teams/{team_id}/members/{username} | Get team member (Legacy)
+*TeamsApi* | [**teams/getMembershipForUserInOrg**](Apis/TeamsApi.http#teams/getmembershipforuserinorg) | **GET** /orgs/{org}/teams/{team_slug}/memberships/{username} | Get team membership for a user
+*TeamsApi* | [**teams/getMembershipForUserLegacy**](Apis/TeamsApi.http#teams/getmembershipforuserlegacy) | **GET** /teams/{team_id}/memberships/{username} | Get team membership for a user (Legacy)
+*TeamsApi* | [**teams/list**](Apis/TeamsApi.http#teams/list) | **GET** /orgs/{org}/teams | List teams
+*TeamsApi* | [**teams/listChildInOrg**](Apis/TeamsApi.http#teams/listchildinorg) | **GET** /orgs/{org}/teams/{team_slug}/teams | List child teams
+*TeamsApi* | [**teams/listChildLegacy**](Apis/TeamsApi.http#teams/listchildlegacy) | **GET** /teams/{team_id}/teams | List child teams (Legacy)
+*TeamsApi* | [**teams/listDiscussionCommentsInOrg**](Apis/TeamsApi.http#teams/listdiscussioncommentsinorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments | List discussion comments
+*TeamsApi* | [**teams/listDiscussionCommentsLegacy**](Apis/TeamsApi.http#teams/listdiscussioncommentslegacy) | **GET** /teams/{team_id}/discussions/{discussion_number}/comments | List discussion comments (Legacy)
+*TeamsApi* | [**teams/listDiscussionsInOrg**](Apis/TeamsApi.http#teams/listdiscussionsinorg) | **GET** /orgs/{org}/teams/{team_slug}/discussions | List discussions
+*TeamsApi* | [**teams/listDiscussionsLegacy**](Apis/TeamsApi.http#teams/listdiscussionslegacy) | **GET** /teams/{team_id}/discussions | List discussions (Legacy)
+*TeamsApi* | [**teams/listForAuthenticatedUser**](Apis/TeamsApi.http#teams/listforauthenticateduser) | **GET** /user/teams | List teams for the authenticated user
+*TeamsApi* | [**teams/listMembersInOrg**](Apis/TeamsApi.http#teams/listmembersinorg) | **GET** /orgs/{org}/teams/{team_slug}/members | List team members
+*TeamsApi* | [**teams/listMembersLegacy**](Apis/TeamsApi.http#teams/listmemberslegacy) | **GET** /teams/{team_id}/members | List team members (Legacy)
+*TeamsApi* | [**teams/listPendingInvitationsInOrg**](Apis/TeamsApi.http#teams/listpendinginvitationsinorg) | **GET** /orgs/{org}/teams/{team_slug}/invitations | List pending team invitations
+*TeamsApi* | [**teams/listPendingInvitationsLegacy**](Apis/TeamsApi.http#teams/listpendinginvitationslegacy) | **GET** /teams/{team_id}/invitations | List pending team invitations (Legacy)
+*TeamsApi* | [**teams/listProjectsInOrg**](Apis/TeamsApi.http#teams/listprojectsinorg) | **GET** /orgs/{org}/teams/{team_slug}/projects | List team projects
+*TeamsApi* | [**teams/listProjectsLegacy**](Apis/TeamsApi.http#teams/listprojectslegacy) | **GET** /teams/{team_id}/projects | List team projects (Legacy)
+*TeamsApi* | [**teams/listReposInOrg**](Apis/TeamsApi.http#teams/listreposinorg) | **GET** /orgs/{org}/teams/{team_slug}/repos | List team repositories
+*TeamsApi* | [**teams/listReposLegacy**](Apis/TeamsApi.http#teams/listreposlegacy) | **GET** /teams/{team_id}/repos | List team repositories (Legacy)
+*TeamsApi* | [**teams/removeMemberLegacy**](Apis/TeamsApi.http#teams/removememberlegacy) | **DELETE** /teams/{team_id}/members/{username} | Remove team member (Legacy)
+*TeamsApi* | [**teams/removeMembershipForUserInOrg**](Apis/TeamsApi.http#teams/removemembershipforuserinorg) | **DELETE** /orgs/{org}/teams/{team_slug}/memberships/{username} | Remove team membership for a user
+*TeamsApi* | [**teams/removeMembershipForUserLegacy**](Apis/TeamsApi.http#teams/removemembershipforuserlegacy) | **DELETE** /teams/{team_id}/memberships/{username} | Remove team membership for a user (Legacy)
+*TeamsApi* | [**teams/removeProjectInOrg**](Apis/TeamsApi.http#teams/removeprojectinorg) | **DELETE** /orgs/{org}/teams/{team_slug}/projects/{project_id} | Remove a project from a team
+*TeamsApi* | [**teams/removeProjectLegacy**](Apis/TeamsApi.http#teams/removeprojectlegacy) | **DELETE** /teams/{team_id}/projects/{project_id} | Remove a project from a team (Legacy)
+*TeamsApi* | [**teams/removeRepoInOrg**](Apis/TeamsApi.http#teams/removerepoinorg) | **DELETE** /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} | Remove a repository from a team
+*TeamsApi* | [**teams/removeRepoLegacy**](Apis/TeamsApi.http#teams/removerepolegacy) | **DELETE** /teams/{team_id}/repos/{owner}/{repo} | Remove a repository from a team (Legacy)
+*TeamsApi* | [**teams/updateDiscussionCommentInOrg**](Apis/TeamsApi.http#teams/updatediscussioncommentinorg) | **PATCH** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number} | Update a discussion comment
+*TeamsApi* | [**teams/updateDiscussionCommentLegacy**](Apis/TeamsApi.http#teams/updatediscussioncommentlegacy) | **PATCH** /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number} | Update a discussion comment (Legacy)
+*TeamsApi* | [**teams/updateDiscussionInOrg**](Apis/TeamsApi.http#teams/updatediscussioninorg) | **PATCH** /orgs/{org}/teams/{team_slug}/discussions/{discussion_number} | Update a discussion
+*TeamsApi* | [**teams/updateDiscussionLegacy**](Apis/TeamsApi.http#teams/updatediscussionlegacy) | **PATCH** /teams/{team_id}/discussions/{discussion_number} | Update a discussion (Legacy)
+*TeamsApi* | [**teams/updateInOrg**](Apis/TeamsApi.http#teams/updateinorg) | **PATCH** /orgs/{org}/teams/{team_slug} | Update a team
+*TeamsApi* | [**teams/updateLegacy**](Apis/TeamsApi.http#teams/updatelegacy) | **PATCH** /teams/{team_id} | Update a team (Legacy)
+*UsersApi* | [**users/addEmailForAuthenticatedUser**](Apis/UsersApi.http#users/addemailforauthenticateduser) | **POST** /user/emails | Add an email address for the authenticated user
+*UsersApi* | [**users/addSocialAccountForAuthenticatedUser**](Apis/UsersApi.http#users/addsocialaccountforauthenticateduser) | **POST** /user/social_accounts | Add social accounts for the authenticated user
+*UsersApi* | [**users/block**](Apis/UsersApi.http#users/block) | **PUT** /user/blocks/{username} | Block a user
+*UsersApi* | [**users/checkBlocked**](Apis/UsersApi.http#users/checkblocked) | **GET** /user/blocks/{username} | Check if a user is blocked by the authenticated user
+*UsersApi* | [**users/checkFollowingForUser**](Apis/UsersApi.http#users/checkfollowingforuser) | **GET** /users/{username}/following/{target_user} | Check if a user follows another user
+*UsersApi* | [**users/checkPersonIsFollowedByAuthenticated**](Apis/UsersApi.http#users/checkpersonisfollowedbyauthenticated) | **GET** /user/following/{username} | Check if a person is followed by the authenticated user
+*UsersApi* | [**users/createGpgKeyForAuthenticatedUser**](Apis/UsersApi.http#users/creategpgkeyforauthenticateduser) | **POST** /user/gpg_keys | Create a GPG key for the authenticated user
+*UsersApi* | [**users/createPublicSshKeyForAuthenticatedUser**](Apis/UsersApi.http#users/createpublicsshkeyforauthenticateduser) | **POST** /user/keys | Create a public SSH key for the authenticated user
+*UsersApi* | [**users/createSshSigningKeyForAuthenticatedUser**](Apis/UsersApi.http#users/createsshsigningkeyforauthenticateduser) | **POST** /user/ssh_signing_keys | Create a SSH signing key for the authenticated user
+*UsersApi* | [**users/deleteEmailForAuthenticatedUser**](Apis/UsersApi.http#users/deleteemailforauthenticateduser) | **DELETE** /user/emails | Delete an email address for the authenticated user
+*UsersApi* | [**users/deleteGpgKeyForAuthenticatedUser**](Apis/UsersApi.http#users/deletegpgkeyforauthenticateduser) | **DELETE** /user/gpg_keys/{gpg_key_id} | Delete a GPG key for the authenticated user
+*UsersApi* | [**users/deletePublicSshKeyForAuthenticatedUser**](Apis/UsersApi.http#users/deletepublicsshkeyforauthenticateduser) | **DELETE** /user/keys/{key_id} | Delete a public SSH key for the authenticated user
+*UsersApi* | [**users/deleteSocialAccountForAuthenticatedUser**](Apis/UsersApi.http#users/deletesocialaccountforauthenticateduser) | **DELETE** /user/social_accounts | Delete social accounts for the authenticated user
+*UsersApi* | [**users/deleteSshSigningKeyForAuthenticatedUser**](Apis/UsersApi.http#users/deletesshsigningkeyforauthenticateduser) | **DELETE** /user/ssh_signing_keys/{ssh_signing_key_id} | Delete an SSH signing key for the authenticated user
+*UsersApi* | [**users/follow**](Apis/UsersApi.http#users/follow) | **PUT** /user/following/{username} | Follow a user
+*UsersApi* | [**users/getAuthenticated**](Apis/UsersApi.http#users/getauthenticated) | **GET** /user | Get the authenticated user
+*UsersApi* | [**users/getByUsername**](Apis/UsersApi.http#users/getbyusername) | **GET** /users/{username} | Get a user
+*UsersApi* | [**users/getContextForUser**](Apis/UsersApi.http#users/getcontextforuser) | **GET** /users/{username}/hovercard | Get contextual information for a user
+*UsersApi* | [**users/getGpgKeyForAuthenticatedUser**](Apis/UsersApi.http#users/getgpgkeyforauthenticateduser) | **GET** /user/gpg_keys/{gpg_key_id} | Get a GPG key for the authenticated user
+*UsersApi* | [**users/getPublicSshKeyForAuthenticatedUser**](Apis/UsersApi.http#users/getpublicsshkeyforauthenticateduser) | **GET** /user/keys/{key_id} | Get a public SSH key for the authenticated user
+*UsersApi* | [**users/getSshSigningKeyForAuthenticatedUser**](Apis/UsersApi.http#users/getsshsigningkeyforauthenticateduser) | **GET** /user/ssh_signing_keys/{ssh_signing_key_id} | Get an SSH signing key for the authenticated user
+*UsersApi* | [**users/list**](Apis/UsersApi.http#users/list) | **GET** /users | List users
+*UsersApi* | [**users/listBlockedByAuthenticatedUser**](Apis/UsersApi.http#users/listblockedbyauthenticateduser) | **GET** /user/blocks | List users blocked by the authenticated user
+*UsersApi* | [**users/listEmailsForAuthenticatedUser**](Apis/UsersApi.http#users/listemailsforauthenticateduser) | **GET** /user/emails | List email addresses for the authenticated user
+*UsersApi* | [**users/listFollowedByAuthenticatedUser**](Apis/UsersApi.http#users/listfollowedbyauthenticateduser) | **GET** /user/following | List the people the authenticated user follows
+*UsersApi* | [**users/listFollowersForAuthenticatedUser**](Apis/UsersApi.http#users/listfollowersforauthenticateduser) | **GET** /user/followers | List followers of the authenticated user
+*UsersApi* | [**users/listFollowersForUser**](Apis/UsersApi.http#users/listfollowersforuser) | **GET** /users/{username}/followers | List followers of a user
+*UsersApi* | [**users/listFollowingForUser**](Apis/UsersApi.http#users/listfollowingforuser) | **GET** /users/{username}/following | List the people a user follows
+*UsersApi* | [**users/listGpgKeysForAuthenticatedUser**](Apis/UsersApi.http#users/listgpgkeysforauthenticateduser) | **GET** /user/gpg_keys | List GPG keys for the authenticated user
+*UsersApi* | [**users/listGpgKeysForUser**](Apis/UsersApi.http#users/listgpgkeysforuser) | **GET** /users/{username}/gpg_keys | List GPG keys for a user
+*UsersApi* | [**users/listPublicEmailsForAuthenticatedUser**](Apis/UsersApi.http#users/listpublicemailsforauthenticateduser) | **GET** /user/public_emails | List public email addresses for the authenticated user
+*UsersApi* | [**users/listPublicKeysForUser**](Apis/UsersApi.http#users/listpublickeysforuser) | **GET** /users/{username}/keys | List public keys for a user
+*UsersApi* | [**users/listPublicSshKeysForAuthenticatedUser**](Apis/UsersApi.http#users/listpublicsshkeysforauthenticateduser) | **GET** /user/keys | List public SSH keys for the authenticated user
+*UsersApi* | [**users/listSocialAccountsForAuthenticatedUser**](Apis/UsersApi.http#users/listsocialaccountsforauthenticateduser) | **GET** /user/social_accounts | List social accounts for the authenticated user
+*UsersApi* | [**users/listSocialAccountsForUser**](Apis/UsersApi.http#users/listsocialaccountsforuser) | **GET** /users/{username}/social_accounts | List social accounts for a user
+*UsersApi* | [**users/listSshSigningKeysForAuthenticatedUser**](Apis/UsersApi.http#users/listsshsigningkeysforauthenticateduser) | **GET** /user/ssh_signing_keys | List SSH signing keys for the authenticated user
+*UsersApi* | [**users/listSshSigningKeysForUser**](Apis/UsersApi.http#users/listsshsigningkeysforuser) | **GET** /users/{username}/ssh_signing_keys | List SSH signing keys for a user
+*UsersApi* | [**users/setPrimaryEmailVisibilityForAuthenticatedUser**](Apis/UsersApi.http#users/setprimaryemailvisibilityforauthenticateduser) | **PATCH** /user/email/visibility | Set primary email visibility for the authenticated user
+*UsersApi* | [**users/unblock**](Apis/UsersApi.http#users/unblock) | **DELETE** /user/blocks/{username} | Unblock a user
+*UsersApi* | [**users/unfollow**](Apis/UsersApi.http#users/unfollow) | **DELETE** /user/following/{username} | Unfollow a user
+*UsersApi* | [**users/updateAuthenticated**](Apis/UsersApi.http#users/updateauthenticated) | **PATCH** /user | Update the authenticated user
+
+
+## Usage
+
+### Prerequisites
+
+You need [IntelliJ](https://www.jetbrains.com/idea/) to be able to run those queries. More information can be found [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+You may have some luck running queries using the [Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) as well, but your mileage may vary.
+
+### Variables and Environment files
+
+* Generally speaking, you want queries to be specific using custom variables. All variables in the `.http` files have the `` format.
+* You can create [public or private environment files](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#environment-variables) to dynamically replace the variables at runtime.
+
+_Note: don't commit private environment files! They typically will contain sensitive information like API Keys._
+
+### Customizations
+
+If you have control over the generation of the files here, there are two main things you can do
+
+* Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator-ignore b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator-ignore
new file mode 100644
index 000000000000..7484ee590a38
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/FILES b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/FILES
new file mode 100644
index 000000000000..ae4035d9e7a5
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/FILES
@@ -0,0 +1,9 @@
+Apis/ClassicCheckoutSDKApi.http
+Apis/DonationsApi.http
+Apis/ModificationsApi.http
+Apis/OrdersApi.http
+Apis/PaymentLinksApi.http
+Apis/PaymentsApi.http
+Apis/RecurringApi.http
+Apis/UtilityApi.http
+README.md
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/VERSION b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/VERSION
new file mode 100644
index 000000000000..c9e125ba1880
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.4.0-SNAPSHOT
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/ClassicCheckoutSDKApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/ClassicCheckoutSDKApi.http
new file mode 100644
index 000000000000..5bab18fd1dcd
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/ClassicCheckoutSDKApi.http
@@ -0,0 +1,151 @@
+## ClassicCheckoutSDKApi
+
+### Create a payment session
+## Set up a payment session (Android)
+POST https://checkout-test.adyen.com/v71/paymentSession
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 17408
+},
+ "reference": "Your order number",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "channel": "Android",
+ "token": "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
+ "returnUrl": "app://",
+ "countryCode": "NL",
+ "shopperLocale": "nl_NL",
+ "sessionValidity": "2017-04-06T13:09:13Z",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Create a payment session
+## Set up a payment session with the option to store card details
+POST https://checkout-test.adyen.com/v71/paymentSession
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 17408
+},
+ "reference": "Your order number",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "enableOneClick": true,
+ "enableRecurring": true,
+ "channel": "Web",
+ "origin": "https://www.yourwebsite.com",
+ "returnUrl": "https://www.yourshop.com/checkout/result",
+ "countryCode": "NL",
+ "shopperLocale": "nl_NL",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "sdkVersion": "1.7.0"
+}
+
+### Create a payment session
+## Set up a payment session (iOS)
+POST https://checkout-test.adyen.com/v71/paymentSession
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 17408
+},
+ "reference": "Your order number",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "channel": "iOS",
+ "token": "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
+ "returnUrl": "app://",
+ "countryCode": "NL",
+ "shopperLocale": "nl_NL",
+ "sessionValidity": "2017-04-06T13:09:13Z",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Create a payment session
+## Split a payment between a sub-merchant and a platform account
+POST https://checkout-test.adyen.com/v71/paymentSession
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 6200
+},
+ "additionalData": {
+ "split.api": "1",
+ "split.nrOfItems": "2",
+ "split.totalAmount": "6200",
+ "split.currencyCode": "EUR",
+ "split.item1.amount": "6000",
+ "split.item1.type": "MarketPlace",
+ "split.item1.account": "151272963",
+ "split.item1.reference": "6124145",
+ "split.item1.description": "Porcelain Doll: Eliza (20cm)",
+ "split.item2.amount": "200",
+ "split.item2.type": "Commission",
+ "split.item2.reference": "6124146"
+},
+ "reference": "Your order number",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "channel": "Android",
+ "token": "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
+ "returnUrl": "app://",
+ "countryCode": "NL",
+ "shopperLocale": "nl_NL",
+ "sessionValidity": "2017-04-06T13:09:13Z",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Create a payment session
+## Set up a payment session (Web)
+POST https://checkout-test.adyen.com/v71/paymentSession
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 17408
+},
+ "reference": "Your order number",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "channel": "Web",
+ "origin": "https://www.yourwebsite.com",
+ "returnUrl": "https://www.yourshop.com/checkout/result",
+ "countryCode": "NL",
+ "shopperLocale": "nl_NL",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "sdkVersion": "1.9.5"
+}
+
+
+### Verify a payment result
+## Verify payment results
+POST https://checkout-test.adyen.com/v71/payments/result
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "payload": "VALUE_YOU_GET_FROM_CHECKOUT_SDK"
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/DonationsApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/DonationsApi.http
new file mode 100644
index 000000000000..a453a5507e18
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/DonationsApi.http
@@ -0,0 +1,53 @@
+## DonationsApi
+
+### Start a transaction for donations
+## Start a donation transaction
+POST https://checkout-test.adyen.com/v71/donations
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "reference": "YOUR_DONATION_REFERENCE",
+ "paymentMethod": {
+ "type": "scheme"
+},
+ "donationToken": "YOUR_DONATION_TOKEN",
+ "donationOriginalPspReference": "991559660454807J",
+ "donationAccount": "CHARITY_ACCOUNT",
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "shopperInteraction": "ContAuth"
+}
+
+### Start a transaction for donations
+## Start a donation transaction with a token
+POST https://checkout-test.adyen.com/v71/donations
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "reference": "YOUR_DONATION_REFERENCE",
+ "paymentMethod": {
+ "type": "scheme",
+ "recurringDetailReference": "7219687191761347"
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "donationAccount": "CHARITY_ACCOUNT",
+ "shopperInteraction": "ContAuth",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "recurringProcessingModel": "CardOnFile"
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/ModificationsApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/ModificationsApi.http
new file mode 100644
index 000000000000..3086a791ba7e
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/ModificationsApi.http
@@ -0,0 +1,103 @@
+## ModificationsApi
+
+### Cancel an authorised payment
+## Cancel a payment using your own reference
+POST https://checkout-test.adyen.com/v71/cancels
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "paymentReference": "YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT",
+ "reference": "YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Update an authorised amount
+## Update the amount of an authorised payment
+POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/amountUpdates
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "amount": {
+ "currency": "EUR",
+ "value": 2500
+},
+ "reference": "YOUR_UNIQUE_REFERENCE"
+}
+
+
+### Cancel an authorised payment
+## Cancel payment using a PSP reference
+POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/cancels
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "reference": "YOUR_UNIQUE_REFERENCE",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Capture an authorised payment
+## Capture an authorised payment
+POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/captures
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "reference": "YOUR_UNIQUE_REFERENCE",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "amount": {
+ "value": 2000,
+ "currency": "EUR"
+},
+ "platformChargebackLogic": {
+ "behavior": "deductFromOneBalanceAccount",
+ "targetAccount": "BA00000000000000000000001",
+ "costAllocationAccount": "BA00000000000000000000001"
+}
+}
+
+
+### Refund a captured payment
+## Refund a payment
+POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/refunds
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 2500
+},
+ "reference": "YOUR_UNIQUE_REFERENCE",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Refund or cancel a payment
+## Reverse (cancel or refund) a payment
+POST https://checkout-test.adyen.com/v71/payments/{{paymentPspReference}}/reversals
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "reference": "YOUR_UNIQUE_REFERENCE",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/OrdersApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/OrdersApi.http
new file mode 100644
index 000000000000..fbfac9e285e2
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/OrdersApi.http
@@ -0,0 +1,79 @@
+## OrdersApi
+
+### Create an order
+## Create an order
+POST https://checkout-test.adyen.com/v71/orders
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "reference": "YOUR_ORDER_REFERENCE",
+ "amount": {
+ "value": 2500,
+ "currency": "EUR"
+},
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Cancel an order
+## Cancel an order
+POST https://checkout-test.adyen.com/v71/orders/cancel
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "order": {
+ "pspReference": "8815517812932012",
+ "orderData": "823fh892f8f18f4...148f13f9f3f"
+},
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Get the balance of a gift card
+## Get gift card balance specifying amount of 10 EUR
+POST https://checkout-test.adyen.com/v71/paymentMethods/balance
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "paymentMethod": {
+ "type": "givex",
+ "number": "4126491073027401",
+ "cvc": "737"
+},
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Get the balance of a gift card
+## Get gift card balance specifying amount of 100 EUR
+POST https://checkout-test.adyen.com/v71/paymentMethods/balance
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "paymentMethod": {
+ "type": "givex",
+ "number": "4126491073027401",
+ "cvc": "737"
+},
+ "amount": {
+ "currency": "EUR",
+ "value": 10000
+},
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentLinksApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentLinksApi.http
new file mode 100644
index 000000000000..b6e39ff44d19
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentLinksApi.http
@@ -0,0 +1,59 @@
+## PaymentLinksApi
+
+### Get a payment link
+## Get a payment link
+GET https://checkout-test.adyen.com/v71/paymentLinks/{{linkId}}
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+### Update the status of a payment link
+## Update the status of a payment link
+PATCH https://checkout-test.adyen.com/v71/paymentLinks/{{linkId}}
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "status": "expired"
+}
+
+
+### Create a payment link
+## Create a payment link
+POST https://checkout-test.adyen.com/v71/paymentLinks
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "reference": "YOUR_ORDER_NUMBER",
+ "amount": {
+ "value": 1250,
+ "currency": "BRL"
+},
+ "countryCode": "BR",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "shopperEmail": "test@email.com",
+ "shopperLocale": "pt-BR",
+ "billingAddress": {
+ "street": "Roque Petroni Jr",
+ "postalCode": "59000060",
+ "city": "São Paulo",
+ "houseNumberOrName": "999",
+ "country": "BR",
+ "stateOrProvince": "SP"
+},
+ "deliveryAddress": {
+ "street": "Roque Petroni Jr",
+ "postalCode": "59000060",
+ "city": "São Paulo",
+ "houseNumberOrName": "999",
+ "country": "BR",
+ "stateOrProvince": "SP"
+}
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentsApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentsApi.http
new file mode 100644
index 000000000000..1da649be2c5d
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/PaymentsApi.http
@@ -0,0 +1,638 @@
+## PaymentsApi
+
+### Get the result of a payment session
+## Get the result of a payment session
+GET https://checkout-test.adyen.com/v71/sessions/{{sessionId}}
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+### Get the list of brands on the card
+## Get a list of brands on a card
+POST https://checkout-test.adyen.com/v71/cardDetails
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "cardNumber": "411111"
+}
+
+### Get the list of brands on the card
+## Get a list of brands on a card specifying your supported card brands
+POST https://checkout-test.adyen.com/v71/cardDetails
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "cardNumber": "411111",
+ "supportedBrands": ["visa","mc","amex"]
+}
+
+
+### Get a list of available payment methods
+## Get available payment methods
+POST https://checkout-test.adyen.com/v71/paymentMethods
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Get a list of available payment methods
+## Get payment methods based on the country and amount
+POST https://checkout-test.adyen.com/v71/paymentMethods
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "countryCode": "NL",
+ "shopperLocale": "nl-NL",
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+}
+}
+
+### Get a list of available payment methods
+## Get payment methods including stored card details
+POST https://checkout-test.adyen.com/v71/paymentMethods
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "countryCode": "NL",
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "shopperReference": "YOUR_SHOPPER_REFERENCE"
+}
+
+
+### Start a transaction
+## Make an Apple Pay payment
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "applepay",
+ "applePayToken": "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..."
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a card payment with 3D Secure 2 native authentication
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "reference": "YOUR_ORDER_NUMBER",
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4035501428146300",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737",
+ "holderName": "John Smith"
+},
+ "authenticationData": {
+ "threeDSRequestData": {
+ "nativeThreeDS": "preferred"
+}
+},
+ "billingAddress": {
+ "country": "US",
+ "city": "New York",
+ "street": "Redwood Block",
+ "houseNumberOrName": "37C",
+ "stateOrProvince": "NY",
+ "postalCode": "10039"
+},
+ "shopperEmail": "s.hopper@test.com",
+ "shopperIP": "192.0.2.1",
+ "browserInfo": {
+ "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
+ "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+ "language": "nl-NL",
+ "colorDepth": 24,
+ "screenHeight": 723,
+ "screenWidth": 1536,
+ "timeZoneOffset": 0,
+ "javaEnabled": true
+},
+ "channel": "Web",
+ "origin": "https://your-company.com",
+ "returnUrl": "https://your-company.com/checkout/",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a card payment with 3D Secure redirect authentication
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "number": "4212345678901237",
+ "expiryMonth": "03",
+ "expiryYear": "2030",
+ "holderName": "John Smith",
+ "cvc": "737"
+},
+ "browserInfo": {
+ "userAgent": "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0",
+ "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+ "javaEnabled": true,
+ "colorDepth": 10,
+ "screenHeight": 2000,
+ "screenWidth": 3000,
+ "timeZoneOffset": 5,
+ "language": "en"
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a card payment with unencrypted card details
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "number": "4111111111111111",
+ "expiryMonth": "03",
+ "expiryYear": "2030",
+ "holderName": "John Smith",
+ "cvc": "737"
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a card payment
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4111111111111111",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737"
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Tokenize card details for one-off payments
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4111111111111111",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737"
+},
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "storePaymentMethod": true,
+ "shopperInteraction": "Ecommerce",
+ "recurringProcessingModel": "CardOnFile",
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a Google Pay payment
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "paywithgoogle",
+ "googlePayToken": "==Payload as retrieved from Google Pay response=="
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YourMerchantAccount"
+}
+
+### Start a transaction
+## Make an iDEAL payment
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "EUR",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "ideal",
+ "issuer": "1121"
+},
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+### Start a transaction
+## Make a Klarna payment
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "reference": "YOUR_ORDER_REFERENCE",
+ "paymentMethod": {
+ "type": "klarna"
+},
+ "amount": {
+ "currency": "SEK",
+ "value": 1000
+},
+ "shopperLocale": "en_US",
+ "countryCode": "SE",
+ "telephoneNumber": "+46 840 839 298",
+ "shopperEmail": "youremail@email.com",
+ "shopperName": {
+ "firstName": "Testperson-se",
+ "lastName": "Approved"
+},
+ "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
+ "billingAddress": {
+ "city": "Ankeborg",
+ "country": "SE",
+ "houseNumberOrName": "1",
+ "postalCode": "12345",
+ "street": "Stargatan"
+},
+ "deliveryAddress": {
+ "city": "Ankeborg",
+ "country": "SE",
+ "houseNumberOrName": "1",
+ "postalCode": "12345",
+ "street": "Stargatan"
+},
+ "returnUrl": "https://www.your-company.com/...",
+ "lineItems": ["{quantity=1, amountExcludingTax=331, taxPercentage=2100, description=Shoes, id=Item #1, taxAmount=69, amountIncludingTax=400, productUrl=URL_TO_PURCHASED_ITEM, imageUrl=URL_TO_PICTURE_OF_PURCHASED_ITEM}","{quantity=2, amountExcludingTax=248, taxPercentage=2100, description=Socks, id=Item #2, taxAmount=52, amountIncludingTax=300, productUrl=URL_TO_PURCHASED_ITEM, imageUrl=URL_TO_PICTURE_OF_PURCHASED_ITEM}"]
+}
+
+### Start a transaction
+## Make a one-off payment with a token and CVV
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "storedPaymentMethodId": "8416038790273850",
+ "encryptedSecurityCode": "adyenjs_0_1_18$MT6ppy0FAMVMLH..."
+},
+ "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_6738oneoff",
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "shopperInteraction": "ContAuth",
+ "recurringProcessingModel": "CardOnFile"
+}
+
+### Start a transaction
+## Make a subscription card payment with a token
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "storedPaymentMethodId": "8316038796685850"
+},
+ "shopperReference": "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription",
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "shopperInteraction": "ContAuth",
+ "recurringProcessingModel": "Subscription"
+}
+
+### Start a transaction
+## Split a payment between balance accounts
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4111111111111111",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737"
+},
+ "amount": {
+ "value": 40000,
+ "currency": "USD"
+},
+ "reference": "YOUR_ORDER_NUMBER",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "returnUrl": "https://your-company.com/...",
+ "platformChargebackLogic": {
+ "behavior": "deductFromOneBalanceAccount",
+ "targetAccount": "BA00000000000000000000001",
+ "costAllocationAccount": "BA00000000000000000000001"
+},
+ "splits": ["{amount={value=39600}, type=BalanceAccount, account=BA00000000000000000000001, reference=Your reference for the sale amount, description=Your description for the sale amount}","{amount={value=400}, type=Commission, reference=Your reference for the commission, description=Your description for the commission}","{type=PaymentFee, account=BA00000000000000000000001, reference=Your reference for the fees, description=Your description for the fees}"]
+}
+
+### Start a transaction
+## Split a payment in a Classic Platforms integration
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4111111111111111",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737"
+},
+ "amount": {
+ "value": 6200,
+ "currency": "EUR"
+},
+ "reference": "YOUR_ORDER_NUMBER",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "returnUrl": "https://your-company.com/...",
+ "splits": ["{amount={value=6000}, type=MarketPlace, account=151272963, reference=6124145, description=Porcelain Doll: Eliza (20cm)}","{amount={value=200}, type=Commission, reference=6124146}"]
+}
+
+### Start a transaction
+## Tokenize card details for a subscription
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "currency": "USD",
+ "value": 1000
+},
+ "reference": "Your order number",
+ "paymentMethod": {
+ "type": "scheme",
+ "encryptedCardNumber": "test_4111111111111111",
+ "encryptedExpiryMonth": "test_03",
+ "encryptedExpiryYear": "test_2030",
+ "encryptedSecurityCode": "test_737"
+},
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "storePaymentMethod": true,
+ "shopperInteraction": "Ecommerce",
+ "recurringProcessingModel": "Subscription",
+ "returnUrl": "https://your-company.com/...",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}
+
+
+### Submit details for a payment
+## Submit the redirect result
+POST https://checkout-test.adyen.com/v71/payments/details
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "details": {
+ "redirectResult": "X6XtfGC3!Y..."
+}
+}
+
+### Submit details for a payment
+## Submit 3D Secure 2 authentication result
+POST https://checkout-test.adyen.com/v71/payments/details
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "details": {
+ "threeDSResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
+}
+}
+
+
+### Create a payment session
+## Create a payment session
+POST https://checkout-test.adyen.com/v71/sessions
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "amount": {
+ "value": 100,
+ "currency": "EUR"
+},
+ "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
+ "reference": "YOUR_PAYMENT_REFERENCE",
+ "countryCode": "NL"
+}
+
+### Create a payment session
+## Create a payment session including Klarna fields
+POST https://checkout-test.adyen.com/v71/sessions
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "reference": "YOUR_ORDER_REFERENCE",
+ "amount": {
+ "currency": "SEK",
+ "value": 1000
+},
+ "shopperLocale": "en_US",
+ "countryCode": "SE",
+ "telephoneNumber": "+46 840 839 298",
+ "shopperEmail": "youremail@email.com",
+ "shopperName": {
+ "firstName": "Testperson-se",
+ "lastName": "Approved"
+},
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "billingAddress": {
+ "city": "Ankeborg",
+ "country": "SE",
+ "houseNumberOrName": "1",
+ "postalCode": "12345",
+ "street": "Stargatan"
+},
+ "deliveryAddress": {
+ "city": "Ankeborg",
+ "country": "SE",
+ "houseNumberOrName": "1",
+ "postalCode": "12345",
+ "street": "Stargatan"
+},
+ "dateOfBirth": "1996-09-04",
+ "socialSecurityNumber": "0108",
+ "returnUrl": "https://example.org",
+ "lineItems": ["{quantity=1, amountExcludingTax=331, taxPercentage=2100, description=Shoes, id=Item #1, taxAmount=69, amountIncludingTax=400, productUrl=URL_TO_PURCHASED_ITEM, imageUrl=URL_TO_PICTURE_OF_PURCHASED_ITEM}","{quantity=2, amountExcludingTax=248, taxPercentage=2100, description=Socks, id=Item #2, taxAmount=52, amountIncludingTax=300, productUrl=URL_TO_PURCHASED_ITEM, imageUrl=URL_TO_PICTURE_OF_PURCHASED_ITEM}"]
+}
+
+### Create a payment session
+## Tokenize card details for one-off payments without asking shopper
+POST https://checkout-test.adyen.com/v71/sessions
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "merchantAccount": "TestMerchantCheckout",
+ "amount": {
+ "value": 100,
+ "currency": "EUR"
+},
+ "shopperReference": "YOUR_SHOPPER_REFERENCE",
+ "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
+ "reference": "YOUR_PAYMENT_REFERENCE",
+ "countryCode": "NL",
+ "storePaymentMethodMode": "enabled",
+ "shopperInteraction": "Ecommerce",
+ "recurringProcessingModel": "CardOnFile"
+}
+
+### Create a payment session
+## Split a payment between balance accounts
+POST https://checkout-test.adyen.com/v71/sessions
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "amount": {
+ "value": 40000,
+ "currency": "USD"
+},
+ "reference": "YOUR_ORDER_NUMBER",
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+ "returnUrl": "https://your-company.com/...",
+ "splits": ["{amount={value=39200}, type=BalanceAccount, account=BA00000000000000000000001, reference=Your reference for the sale amount, description=Your description for the sale amount}","{amount={value=400}, type=Commission, reference=Your reference for the commission, description=Your description for the commission}","{amount={value=400}, account=BA00000000000000000000001, reference=Your reference for the fees, description=Your description for the fees, type=PaymentFee}"]
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/RecurringApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/RecurringApi.http
new file mode 100644
index 000000000000..72150a2723fc
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/RecurringApi.http
@@ -0,0 +1,14 @@
+## RecurringApi
+
+### Delete a token for stored payment details
+## Delete a token for stored payment details
+DELETE https://checkout-test.adyen.com/v71/storedPaymentMethods/{{storedPaymentMethodId}}
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+### Get tokens for stored payment details
+## Get tokens for stored payment details
+GET https://checkout-test.adyen.com/v71/storedPaymentMethods
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/Apis/UtilityApi.http b/samples/client/jetbrains/adyen/adyen/http/client/Apis/UtilityApi.http
new file mode 100644
index 000000000000..66189fa7d99d
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/Apis/UtilityApi.http
@@ -0,0 +1,29 @@
+## UtilityApi
+
+### Get an Apple Pay session
+## Get payment session for Apple Pay
+POST https://checkout-test.adyen.com/v71/applePay/sessions
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "displayName": "YOUR_MERCHANT_NAME",
+ "domainName": "YOUR_DOMAIN_NAME",
+ "merchantIdentifier": "YOUR_MERCHANT_ID"
+}
+
+
+### Create originKey values for domains
+## Get origin keys
+POST https://checkout-test.adyen.com/v71/originKeys
+Content-Type: application/json
+Accept: application/json
+Authorization: Basic: {{username-password}}
+X-API-Key: {{apiKey}}
+
+{
+ "originDomains": ["https://www.your-domain1.com","https://www.your-domain2.com","https://www.your-domain3.com"]
+}
+
diff --git a/samples/client/jetbrains/adyen/adyen/http/client/README.md b/samples/client/jetbrains/adyen/adyen/http/client/README.md
new file mode 100644
index 000000000000..9322d0676f4f
--- /dev/null
+++ b/samples/client/jetbrains/adyen/adyen/http/client/README.md
@@ -0,0 +1,69 @@
+# Adyen Checkout API - Jetbrains API Client
+
+## General API description
+
+Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). ## Authentication Each request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://checkout-test.adyen.com/v71/payments ``` ## Going live To access the live endpoints, you need an API key from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account, for example: ``` https://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. When preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place. ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=71) to find out what changed in this version!
+
+* API basepath : [https://checkout-test.adyen.com/v71](https://checkout-test.adyen.com/v71)
+* Version : 71
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://checkout-test.adyen.com/v71*, but will link to the `.http` file that contains the endpoint definition.
+There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ClassicCheckoutSDKApi* | [**postPaymentSession**](Apis/ClassicCheckoutSDKApi.http#postpaymentsession) | **POST** /paymentSession | Create a payment session
+*ClassicCheckoutSDKApi* | [**postPaymentsResult**](Apis/ClassicCheckoutSDKApi.http#postpaymentsresult) | **POST** /payments/result | Verify a payment result
+*DonationsApi* | [**postDonations**](Apis/DonationsApi.http#postdonations) | **POST** /donations | Start a transaction for donations
+*ModificationsApi* | [**postCancels**](Apis/ModificationsApi.http#postcancels) | **POST** /cancels | Cancel an authorised payment
+*ModificationsApi* | [**postPaymentsPaymentPspReferenceAmountUpdates**](Apis/ModificationsApi.http#postpaymentspaymentpspreferenceamountupdates) | **POST** /payments/{paymentPspReference}/amountUpdates | Update an authorised amount
+*ModificationsApi* | [**postPaymentsPaymentPspReferenceCancels**](Apis/ModificationsApi.http#postpaymentspaymentpspreferencecancels) | **POST** /payments/{paymentPspReference}/cancels | Cancel an authorised payment
+*ModificationsApi* | [**postPaymentsPaymentPspReferenceCaptures**](Apis/ModificationsApi.http#postpaymentspaymentpspreferencecaptures) | **POST** /payments/{paymentPspReference}/captures | Capture an authorised payment
+*ModificationsApi* | [**postPaymentsPaymentPspReferenceRefunds**](Apis/ModificationsApi.http#postpaymentspaymentpspreferencerefunds) | **POST** /payments/{paymentPspReference}/refunds | Refund a captured payment
+*ModificationsApi* | [**postPaymentsPaymentPspReferenceReversals**](Apis/ModificationsApi.http#postpaymentspaymentpspreferencereversals) | **POST** /payments/{paymentPspReference}/reversals | Refund or cancel a payment
+*OrdersApi* | [**postOrders**](Apis/OrdersApi.http#postorders) | **POST** /orders | Create an order
+*OrdersApi* | [**postOrdersCancel**](Apis/OrdersApi.http#postorderscancel) | **POST** /orders/cancel | Cancel an order
+*OrdersApi* | [**postPaymentMethodsBalance**](Apis/OrdersApi.http#postpaymentmethodsbalance) | **POST** /paymentMethods/balance | Get the balance of a gift card
+*PaymentLinksApi* | [**getPaymentLinksLinkId**](Apis/PaymentLinksApi.http#getpaymentlinkslinkid) | **GET** /paymentLinks/{linkId} | Get a payment link
+*PaymentLinksApi* | [**patchPaymentLinksLinkId**](Apis/PaymentLinksApi.http#patchpaymentlinkslinkid) | **PATCH** /paymentLinks/{linkId} | Update the status of a payment link
+*PaymentLinksApi* | [**postPaymentLinks**](Apis/PaymentLinksApi.http#postpaymentlinks) | **POST** /paymentLinks | Create a payment link
+*PaymentsApi* | [**getSessionsSessionId**](Apis/PaymentsApi.http#getsessionssessionid) | **GET** /sessions/{sessionId} | Get the result of a payment session
+*PaymentsApi* | [**postCardDetails**](Apis/PaymentsApi.http#postcarddetails) | **POST** /cardDetails | Get the list of brands on the card
+*PaymentsApi* | [**postPaymentMethods**](Apis/PaymentsApi.http#postpaymentmethods) | **POST** /paymentMethods | Get a list of available payment methods
+*PaymentsApi* | [**postPayments**](Apis/PaymentsApi.http#postpayments) | **POST** /payments | Start a transaction
+*PaymentsApi* | [**postPaymentsDetails**](Apis/PaymentsApi.http#postpaymentsdetails) | **POST** /payments/details | Submit details for a payment
+*PaymentsApi* | [**postSessions**](Apis/PaymentsApi.http#postsessions) | **POST** /sessions | Create a payment session
+*RecurringApi* | [**deleteStoredPaymentMethodsStoredPaymentMethodId**](Apis/RecurringApi.http#deletestoredpaymentmethodsstoredpaymentmethodid) | **DELETE** /storedPaymentMethods/{storedPaymentMethodId} | Delete a token for stored payment details
+*RecurringApi* | [**getStoredPaymentMethods**](Apis/RecurringApi.http#getstoredpaymentmethods) | **GET** /storedPaymentMethods | Get tokens for stored payment details
+*UtilityApi* | [**postApplePaySessions**](Apis/UtilityApi.http#postapplepaysessions) | **POST** /applePay/sessions | Get an Apple Pay session
+*UtilityApi* | [**postOriginKeys**](Apis/UtilityApi.http#postoriginkeys) | **POST** /originKeys | Create originKey values for domains
+
+
+## Usage
+
+### Prerequisites
+
+You need [IntelliJ](https://www.jetbrains.com/idea/) to be able to run those queries. More information can be found [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+You may have some luck running queries using the [Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) as well, but your mileage may vary.
+
+### Variables and Environment files
+
+* Generally speaking, you want queries to be specific using custom variables. All variables in the `.http` files have the `` format.
+* You can create [public or private environment files](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#environment-variables) to dynamically replace the variables at runtime.
+
+_Note: don't commit private environment files! They typically will contain sensitive information like API Keys._
+
+### Customizations
+
+If you have control over the generation of the files here, there are two main things you can do
+
+* Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file
diff --git a/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator-ignore b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator-ignore
new file mode 100644
index 000000000000..7484ee590a38
--- /dev/null
+++ b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/FILES b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/FILES
new file mode 100644
index 000000000000..bfbdad8e4764
--- /dev/null
+++ b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/FILES
@@ -0,0 +1,2 @@
+Apis/PaymentsApi.http
+README.md
diff --git a/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/VERSION b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/VERSION
new file mode 100644
index 000000000000..c9e125ba1880
--- /dev/null
+++ b/samples/client/jetbrains/adyen/checkoutbasic/http/client/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.4.0-SNAPSHOT
diff --git a/samples/client/jetbrains/adyen/checkoutbasic/http/client/Apis/PaymentsApi.http b/samples/client/jetbrains/adyen/checkoutbasic/http/client/Apis/PaymentsApi.http
new file mode 100644
index 000000000000..8ced923e891c
--- /dev/null
+++ b/samples/client/jetbrains/adyen/checkoutbasic/http/client/Apis/PaymentsApi.http
@@ -0,0 +1,69 @@
+## PaymentsApi
+
+### Get payment method by id
+## Get payment method by id
+GET https://checkout-test.adyen.com/v71/paymentMethods/{{id}}
+Accept: application/json
+
+### Get payment methods
+## Get payment methods
+GET https://checkout-test.adyen.com/v71/paymentMethods
+Accept: application/json
+
+### Make a payment
+## ApplePay request
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "paymentMethod" : {
+ "name" : "applepay"
+ },
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 1000
+ },
+ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
+ "reference" : "YOUR_REFERENCE",
+ "channel" : "iOS"
+}
+
+### Make a payment
+## GooglePay request
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "paymentMethod" : {
+ "name" : "googlepay"
+ },
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 1000
+ },
+ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
+ "reference" : "YOUR_REFERENCE",
+ "channel" : "Android"
+}
+
+### Make a payment
+## Example with a merchant account that doesn't exist
+POST https://checkout-test.adyen.com/v71/payments
+Content-Type: application/json
+Accept: application/json
+
+{
+ "paymentMethod" : {
+ "name" : "googlepay"
+ },
+ "amount" : {
+ "currency" : "EUR",
+ "value" : 1000
+ },
+ "merchantAccount" : "INVALID MERCHANT ACCOUNT",
+ "reference" : "YOUR_REFERENCE",
+ "channel" : "Android"
+}
+
diff --git a/samples/client/jetbrains/adyen/checkoutbasic/http/client/README.md b/samples/client/jetbrains/adyen/checkoutbasic/http/client/README.md
new file mode 100644
index 000000000000..48c3b86a50a3
--- /dev/null
+++ b/samples/client/jetbrains/adyen/checkoutbasic/http/client/README.md
@@ -0,0 +1,47 @@
+# Checkout Basic - Jetbrains API Client
+
+## General API description
+
+Checkout Basic
+
+* API basepath : [https://checkout-test.adyen.com/v71](https://checkout-test.adyen.com/v71)
+* Version : 1.0.0
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://checkout-test.adyen.com/v71*, but will link to the `.http` file that contains the endpoint definition.
+There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PaymentsApi* | [**getPaymentMethodById**](Apis/PaymentsApi.http#getpaymentmethodbyid) | **GET** /paymentMethods/{id} | Get payment method by id
+*PaymentsApi* | [**getPaymentMethods**](Apis/PaymentsApi.http#getpaymentmethods) | **GET** /paymentMethods | Get payment methods
+*PaymentsApi* | [**postMakePayment**](Apis/PaymentsApi.http#postmakepayment) | **POST** /payments | Make a payment
+
+
+## Usage
+
+### Prerequisites
+
+You need [IntelliJ](https://www.jetbrains.com/idea/) to be able to run those queries. More information can be found [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+You may have some luck running queries using the [Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) as well, but your mileage may vary.
+
+### Variables and Environment files
+
+* Generally speaking, you want queries to be specific using custom variables. All variables in the `.http` files have the `` format.
+* You can create [public or private environment files](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#environment-variables) to dynamically replace the variables at runtime.
+
+_Note: don't commit private environment files! They typically will contain sensitive information like API Keys._
+
+### Customizations
+
+If you have control over the generation of the files here, there are two main things you can do
+
+* Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file
diff --git a/samples/client/opendota/jetbrains/http/client/.openapi-generator-ignore b/samples/client/opendota/jetbrains/http/client/.openapi-generator-ignore
new file mode 100644
index 000000000000..7484ee590a38
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/samples/client/opendota/jetbrains/http/client/.openapi-generator/FILES b/samples/client/opendota/jetbrains/http/client/.openapi-generator/FILES
new file mode 100644
index 000000000000..509584327d3f
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/.openapi-generator/FILES
@@ -0,0 +1,28 @@
+Apis/BenchmarksApi.http
+Apis/ConstantsApi.http
+Apis/DistributionsApi.http
+Apis/ExplorerApi.http
+Apis/FindMatchesApi.http
+Apis/HealthApi.http
+Apis/HeroStatsApi.http
+Apis/HeroesApi.http
+Apis/LeaguesApi.http
+Apis/LiveApi.http
+Apis/MatchesApi.http
+Apis/MetadataApi.http
+Apis/ParsedMatchesApi.http
+Apis/PlayersApi.http
+Apis/PlayersByRankApi.http
+Apis/ProMatchesApi.http
+Apis/ProPlayersApi.http
+Apis/PublicMatchesApi.http
+Apis/RankingsApi.http
+Apis/RecordsApi.http
+Apis/ReplaysApi.http
+Apis/RequestApi.http
+Apis/ScenariosApi.http
+Apis/SchemaApi.http
+Apis/SearchApi.http
+Apis/StatusApi.http
+Apis/TeamsApi.http
+README.md
diff --git a/samples/client/opendota/jetbrains/http/client/.openapi-generator/VERSION b/samples/client/opendota/jetbrains/http/client/.openapi-generator/VERSION
new file mode 100644
index 000000000000..c9e125ba1880
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.4.0-SNAPSHOT
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/BenchmarksApi.http b/samples/client/opendota/jetbrains/http/client/Apis/BenchmarksApi.http
new file mode 100644
index 000000000000..51198b290064
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/BenchmarksApi.http
@@ -0,0 +1,6 @@
+## BenchmarksApi
+
+### GET /benchmarks
+## GET /benchmarks
+GET https://api.opendota.com/api/benchmarks
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ConstantsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ConstantsApi.http
new file mode 100644
index 000000000000..c5480cc2079f
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ConstantsApi.http
@@ -0,0 +1,11 @@
+## ConstantsApi
+
+### GET /constants
+## GET /constants
+GET https://api.opendota.com/api/constants
+Accept: application/json; charset=utf-8
+
+### GET /constants
+## GET /constants
+GET https://api.opendota.com/api/constants/{{resource}}
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/DistributionsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/DistributionsApi.http
new file mode 100644
index 000000000000..75590100e298
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/DistributionsApi.http
@@ -0,0 +1,6 @@
+## DistributionsApi
+
+### GET /distributions
+## GET /distributions
+GET https://api.opendota.com/api/distributions
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ExplorerApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ExplorerApi.http
new file mode 100644
index 000000000000..c8cd683cfb63
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ExplorerApi.http
@@ -0,0 +1,6 @@
+## ExplorerApi
+
+### GET /explorer
+## GET /explorer
+GET https://api.opendota.com/api/explorer
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/FindMatchesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/FindMatchesApi.http
new file mode 100644
index 000000000000..98dff2dc01b9
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/FindMatchesApi.http
@@ -0,0 +1,6 @@
+## FindMatchesApi
+
+### GET /
+## GET /
+GET https://api.opendota.com/api/findMatches
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/HealthApi.http b/samples/client/opendota/jetbrains/http/client/Apis/HealthApi.http
new file mode 100644
index 000000000000..748d71fc0336
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/HealthApi.http
@@ -0,0 +1,6 @@
+## HealthApi
+
+### GET /health
+## GET /health
+GET https://api.opendota.com/api/health
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/HeroStatsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/HeroStatsApi.http
new file mode 100644
index 000000000000..64bbccae7c06
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/HeroStatsApi.http
@@ -0,0 +1,6 @@
+## HeroStatsApi
+
+### GET /heroStats
+## GET /heroStats
+GET https://api.opendota.com/api/heroStats
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/HeroesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/HeroesApi.http
new file mode 100644
index 000000000000..aa3f625e04b3
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/HeroesApi.http
@@ -0,0 +1,31 @@
+## HeroesApi
+
+### GET /heroes
+## GET /heroes
+GET https://api.opendota.com/api/heroes
+Accept: application/json; charset=utf-8
+
+### GET /heroes/{hero_id}/durations
+## GET /heroes/{hero_id}/durations
+GET https://api.opendota.com/api/heroes/{{hero_id}}/durations
+Accept: application/json; charset=utf-8
+
+### GET /heroes/{hero_id}/itemPopularity
+## GET /heroes/{hero_id}/itemPopularity
+GET https://api.opendota.com/api/heroes/{{hero_id}}/itemPopularity
+Accept: application/json; charset=utf-8
+
+### GET /heroes/{hero_id}/matches
+## GET /heroes/{hero_id}/matches
+GET https://api.opendota.com/api/heroes/{{hero_id}}/matches
+Accept: application/json; charset=utf-8
+
+### GET /heroes/{hero_id}/matchups
+## GET /heroes/{hero_id}/matchups
+GET https://api.opendota.com/api/heroes/{{hero_id}}/matchups
+Accept: application/json; charset=utf-8
+
+### GET /heroes/{hero_id}/players
+## GET /heroes/{hero_id}/players
+GET https://api.opendota.com/api/heroes/{{hero_id}}/players
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/LeaguesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/LeaguesApi.http
new file mode 100644
index 000000000000..b0157c03223c
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/LeaguesApi.http
@@ -0,0 +1,21 @@
+## LeaguesApi
+
+### GET /leagues
+## GET /leagues
+GET https://api.opendota.com/api/leagues
+Accept: application/json; charset=utf-8
+
+### GET /leagues/{league_id}
+## GET /leagues/{league_id}
+GET https://api.opendota.com/api/leagues/{{league_id}}
+Accept: application/json; charset=utf-8
+
+### GET /leagues/{league_id}/matches
+## GET /leagues/{league_id}/matches
+GET https://api.opendota.com/api/leagues/{{league_id}}/matches
+Accept: application/json; charset=utf-8
+
+### GET /leagues/{league_id}/teams
+## GET /leagues/{league_id}/teams
+GET https://api.opendota.com/api/leagues/{{league_id}}/teams
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/LiveApi.http b/samples/client/opendota/jetbrains/http/client/Apis/LiveApi.http
new file mode 100644
index 000000000000..9c8eb9c3ac7b
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/LiveApi.http
@@ -0,0 +1,6 @@
+## LiveApi
+
+### GET /live
+## GET /live
+GET https://api.opendota.com/api/live
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/MatchesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/MatchesApi.http
new file mode 100644
index 000000000000..1fe793a7d42d
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/MatchesApi.http
@@ -0,0 +1,6 @@
+## MatchesApi
+
+### GET /matches/{match_id}
+## GET /matches/{match_id}
+GET https://api.opendota.com/api/matches/{{match_id}}
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/MetadataApi.http b/samples/client/opendota/jetbrains/http/client/Apis/MetadataApi.http
new file mode 100644
index 000000000000..5b755973438b
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/MetadataApi.http
@@ -0,0 +1,6 @@
+## MetadataApi
+
+### GET /metadata
+## GET /metadata
+GET https://api.opendota.com/api/metadata
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ParsedMatchesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ParsedMatchesApi.http
new file mode 100644
index 000000000000..d34b5820e395
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ParsedMatchesApi.http
@@ -0,0 +1,6 @@
+## ParsedMatchesApi
+
+### GET /parsedMatches
+## GET /parsedMatches
+GET https://api.opendota.com/api/parsedMatches
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/PlayersApi.http b/samples/client/opendota/jetbrains/http/client/Apis/PlayersApi.http
new file mode 100644
index 000000000000..3d01db4f8ebb
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/PlayersApi.http
@@ -0,0 +1,76 @@
+## PlayersApi
+
+### GET /players/{account_id}/counts
+## GET /players/{account_id}/counts
+GET https://api.opendota.com/api/players/{{account_id}}/counts
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}
+## GET /players/{account_id}
+GET https://api.opendota.com/api/players/{{account_id}}
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/heroes
+## GET /players/{account_id}/heroes
+GET https://api.opendota.com/api/players/{{account_id}}/heroes
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/histograms
+## GET /players/{account_id}/histograms
+GET https://api.opendota.com/api/players/{{account_id}}/histograms/{{field}}
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/matches
+## GET /players/{account_id}/matches
+GET https://api.opendota.com/api/players/{{account_id}}/matches
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/peers
+## GET /players/{account_id}/peers
+GET https://api.opendota.com/api/players/{{account_id}}/peers
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/pros
+## GET /players/{account_id}/pros
+GET https://api.opendota.com/api/players/{{account_id}}/pros
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/rankings
+## GET /players/{account_id}/rankings
+GET https://api.opendota.com/api/players/{{account_id}}/rankings
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/ratings
+## GET /players/{account_id}/ratings
+GET https://api.opendota.com/api/players/{{account_id}}/ratings
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/recentMatches
+## GET /players/{account_id}/recentMatches
+GET https://api.opendota.com/api/players/{{account_id}}/recentMatches
+Accept: application/json; charset=utf-8
+
+### POST /players/{account_id}/refresh
+## POST /players/{account_id}/refresh
+POST https://api.opendota.com/api/players/{{account_id}}/refresh
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/totals
+## GET /players/{account_id}/totals
+GET https://api.opendota.com/api/players/{{account_id}}/totals
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/wardmap
+## GET /players/{account_id}/wardmap
+GET https://api.opendota.com/api/players/{{account_id}}/wardmap
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/wl
+## GET /players/{account_id}/wl
+GET https://api.opendota.com/api/players/{{account_id}}/wl
+Accept: application/json; charset=utf-8
+
+### GET /players/{account_id}/wordcloud
+## GET /players/{account_id}/wordcloud
+GET https://api.opendota.com/api/players/{{account_id}}/wordcloud
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/PlayersByRankApi.http b/samples/client/opendota/jetbrains/http/client/Apis/PlayersByRankApi.http
new file mode 100644
index 000000000000..d108c3bef8b0
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/PlayersByRankApi.http
@@ -0,0 +1,6 @@
+## PlayersByRankApi
+
+### GET /playersByRank
+## GET /playersByRank
+GET https://api.opendota.com/api/playersByRank
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ProMatchesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ProMatchesApi.http
new file mode 100644
index 000000000000..56f6646bcef9
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ProMatchesApi.http
@@ -0,0 +1,6 @@
+## ProMatchesApi
+
+### GET /proMatches
+## GET /proMatches
+GET https://api.opendota.com/api/proMatches
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ProPlayersApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ProPlayersApi.http
new file mode 100644
index 000000000000..335d4b7e1b86
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ProPlayersApi.http
@@ -0,0 +1,6 @@
+## ProPlayersApi
+
+### GET /proPlayers
+## GET /proPlayers
+GET https://api.opendota.com/api/proPlayers
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/PublicMatchesApi.http b/samples/client/opendota/jetbrains/http/client/Apis/PublicMatchesApi.http
new file mode 100644
index 000000000000..d4ab569a98da
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/PublicMatchesApi.http
@@ -0,0 +1,6 @@
+## PublicMatchesApi
+
+### GET /publicMatches
+## GET /publicMatches
+GET https://api.opendota.com/api/publicMatches
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/RankingsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/RankingsApi.http
new file mode 100644
index 000000000000..4d7645443881
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/RankingsApi.http
@@ -0,0 +1,6 @@
+## RankingsApi
+
+### GET /rankings
+## GET /rankings
+GET https://api.opendota.com/api/rankings
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/RecordsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/RecordsApi.http
new file mode 100644
index 000000000000..772ccce539cb
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/RecordsApi.http
@@ -0,0 +1,6 @@
+## RecordsApi
+
+### GET /records/{field}
+## GET /records/{field}
+GET https://api.opendota.com/api/records/{{field}}
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ReplaysApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ReplaysApi.http
new file mode 100644
index 000000000000..12edf8dc8606
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ReplaysApi.http
@@ -0,0 +1,6 @@
+## ReplaysApi
+
+### GET /replays
+## GET /replays
+GET https://api.opendota.com/api/replays
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/RequestApi.http b/samples/client/opendota/jetbrains/http/client/Apis/RequestApi.http
new file mode 100644
index 000000000000..f538e812b0d7
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/RequestApi.http
@@ -0,0 +1,11 @@
+## RequestApi
+
+### GET /request/{jobId}
+## GET /request/{jobId}
+GET https://api.opendota.com/api/request/{{jobId}}
+Accept: application/json; charset=utf-8
+
+### POST /request/{match_id}
+## POST /request/{match_id}
+POST https://api.opendota.com/api/request/{{match_id}}
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/ScenariosApi.http b/samples/client/opendota/jetbrains/http/client/Apis/ScenariosApi.http
new file mode 100644
index 000000000000..801cf08d3bdc
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/ScenariosApi.http
@@ -0,0 +1,16 @@
+## ScenariosApi
+
+### GET /scenarios/itemTimings
+## GET /scenarios/itemTimings
+GET https://api.opendota.com/api/scenarios/itemTimings
+Accept: application/json; charset=utf-8
+
+### GET /scenarios/laneRoles
+## GET /scenarios/laneRoles
+GET https://api.opendota.com/api/scenarios/laneRoles
+Accept: application/json; charset=utf-8
+
+### GET /scenarios/misc
+## GET /scenarios/misc
+GET https://api.opendota.com/api/scenarios/misc
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/SchemaApi.http b/samples/client/opendota/jetbrains/http/client/Apis/SchemaApi.http
new file mode 100644
index 000000000000..e5441c6d5da1
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/SchemaApi.http
@@ -0,0 +1,6 @@
+## SchemaApi
+
+### GET /schema
+## GET /schema
+GET https://api.opendota.com/api/schema
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/SearchApi.http b/samples/client/opendota/jetbrains/http/client/Apis/SearchApi.http
new file mode 100644
index 000000000000..066924a4503d
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/SearchApi.http
@@ -0,0 +1,6 @@
+## SearchApi
+
+### GET /search
+## GET /search
+GET https://api.opendota.com/api/search
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/StatusApi.http b/samples/client/opendota/jetbrains/http/client/Apis/StatusApi.http
new file mode 100644
index 000000000000..dbb25530e06d
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/StatusApi.http
@@ -0,0 +1,6 @@
+## StatusApi
+
+### GET /status
+## GET /status
+GET https://api.opendota.com/api/status
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/Apis/TeamsApi.http b/samples/client/opendota/jetbrains/http/client/Apis/TeamsApi.http
new file mode 100644
index 000000000000..7200bf64b80f
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/Apis/TeamsApi.http
@@ -0,0 +1,26 @@
+## TeamsApi
+
+### GET /teams
+## GET /teams
+GET https://api.opendota.com/api/teams
+Accept: application/json; charset=utf-8
+
+### GET /teams/{team_id}
+## GET /teams/{team_id}
+GET https://api.opendota.com/api/teams/{{team_id}}
+Accept: application/json; charset=utf-8
+
+### GET /teams/{team_id}/heroes
+## GET /teams/{team_id}/heroes
+GET https://api.opendota.com/api/teams/{{team_id}}/heroes
+Accept: application/json; charset=utf-8
+
+### GET /teams/{team_id}/matches
+## GET /teams/{team_id}/matches
+GET https://api.opendota.com/api/teams/{{team_id}}/matches
+Accept: application/json; charset=utf-8
+
+### GET /teams/{team_id}/players
+## GET /teams/{team_id}/players
+GET https://api.opendota.com/api/teams/{{team_id}}/players
+Accept: application/json; charset=utf-8
diff --git a/samples/client/opendota/jetbrains/http/client/README.md b/samples/client/opendota/jetbrains/http/client/README.md
new file mode 100644
index 000000000000..6127f6776915
--- /dev/null
+++ b/samples/client/opendota/jetbrains/http/client/README.md
@@ -0,0 +1,101 @@
+# OpenDota API - Jetbrains API Client
+
+## General API description
+
+# Introduction The OpenDota API provides Dota 2 related data including advanced match data extracted from match replays. You can find data that can be used to convert hero and ability IDs and other information provided by the API from the [dotaconstants](https://github.com/odota/dotaconstants) repository. **Beginning 2018-04-22, the OpenDota API is limited to 50,000 free calls per month and 60 requests/minute** We offer a Premium Tier with unlimited API calls and higher rate limits. Check out the [API page](https://www.opendota.com/api-keys) to learn more.
+
+* API basepath : [https://api.opendota.com/api](https://api.opendota.com/api)
+* Version : 20.0.0
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.opendota.com/api*, but will link to the `.http` file that contains the endpoint definition.
+There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BenchmarksApi* | [**benchmarksGet**](Apis/BenchmarksApi.http#benchmarksget) | **GET** /benchmarks | GET /benchmarks
+*ConstantsApi* | [**constantsGet**](Apis/ConstantsApi.http#constantsget) | **GET** /constants | GET /constants
+*ConstantsApi* | [**constantsResourceGet**](Apis/ConstantsApi.http#constantsresourceget) | **GET** /constants/{resource} | GET /constants
+*DistributionsApi* | [**distributionsGet**](Apis/DistributionsApi.http#distributionsget) | **GET** /distributions | GET /distributions
+*ExplorerApi* | [**explorerGet**](Apis/ExplorerApi.http#explorerget) | **GET** /explorer | GET /explorer
+*FindMatchesApi* | [**findMatchesGet**](Apis/FindMatchesApi.http#findmatchesget) | **GET** /findMatches | GET /
+*HealthApi* | [**healthGet**](Apis/HealthApi.http#healthget) | **GET** /health | GET /health
+*HeroStatsApi* | [**heroStatsGet**](Apis/HeroStatsApi.http#herostatsget) | **GET** /heroStats | GET /heroStats
+*HeroesApi* | [**heroesGet**](Apis/HeroesApi.http#heroesget) | **GET** /heroes | GET /heroes
+*HeroesApi* | [**heroesHeroIdDurationsGet**](Apis/HeroesApi.http#heroesheroiddurationsget) | **GET** /heroes/{hero_id}/durations | GET /heroes/{hero_id}/durations
+*HeroesApi* | [**heroesHeroIdItemPopularityGet**](Apis/HeroesApi.http#heroesheroiditempopularityget) | **GET** /heroes/{hero_id}/itemPopularity | GET /heroes/{hero_id}/itemPopularity
+*HeroesApi* | [**heroesHeroIdMatchesGet**](Apis/HeroesApi.http#heroesheroidmatchesget) | **GET** /heroes/{hero_id}/matches | GET /heroes/{hero_id}/matches
+*HeroesApi* | [**heroesHeroIdMatchupsGet**](Apis/HeroesApi.http#heroesheroidmatchupsget) | **GET** /heroes/{hero_id}/matchups | GET /heroes/{hero_id}/matchups
+*HeroesApi* | [**heroesHeroIdPlayersGet**](Apis/HeroesApi.http#heroesheroidplayersget) | **GET** /heroes/{hero_id}/players | GET /heroes/{hero_id}/players
+*LeaguesApi* | [**leaguesGet**](Apis/LeaguesApi.http#leaguesget) | **GET** /leagues | GET /leagues
+*LeaguesApi* | [**leaguesLeagueIdGet**](Apis/LeaguesApi.http#leaguesleagueidget) | **GET** /leagues/{league_id} | GET /leagues/{league_id}
+*LeaguesApi* | [**leaguesLeagueIdMatchesGet**](Apis/LeaguesApi.http#leaguesleagueidmatchesget) | **GET** /leagues/{league_id}/matches | GET /leagues/{league_id}/matches
+*LeaguesApi* | [**leaguesLeagueIdTeamsGet**](Apis/LeaguesApi.http#leaguesleagueidteamsget) | **GET** /leagues/{league_id}/teams | GET /leagues/{league_id}/teams
+*LiveApi* | [**liveGet**](Apis/LiveApi.http#liveget) | **GET** /live | GET /live
+*MatchesApi* | [**matchesMatchIdGet**](Apis/MatchesApi.http#matchesmatchidget) | **GET** /matches/{match_id} | GET /matches/{match_id}
+*MetadataApi* | [**metadataGet**](Apis/MetadataApi.http#metadataget) | **GET** /metadata | GET /metadata
+*ParsedMatchesApi* | [**parsedMatchesGet**](Apis/ParsedMatchesApi.http#parsedmatchesget) | **GET** /parsedMatches | GET /parsedMatches
+*PlayersApi* | [**playersAccountIdCountsGet**](Apis/PlayersApi.http#playersaccountidcountsget) | **GET** /players/{account_id}/counts | GET /players/{account_id}/counts
+*PlayersApi* | [**playersAccountIdGet**](Apis/PlayersApi.http#playersaccountidget) | **GET** /players/{account_id} | GET /players/{account_id}
+*PlayersApi* | [**playersAccountIdHeroesGet**](Apis/PlayersApi.http#playersaccountidheroesget) | **GET** /players/{account_id}/heroes | GET /players/{account_id}/heroes
+*PlayersApi* | [**playersAccountIdHistogramsFieldGet**](Apis/PlayersApi.http#playersaccountidhistogramsfieldget) | **GET** /players/{account_id}/histograms/{field} | GET /players/{account_id}/histograms
+*PlayersApi* | [**playersAccountIdMatchesGet**](Apis/PlayersApi.http#playersaccountidmatchesget) | **GET** /players/{account_id}/matches | GET /players/{account_id}/matches
+*PlayersApi* | [**playersAccountIdPeersGet**](Apis/PlayersApi.http#playersaccountidpeersget) | **GET** /players/{account_id}/peers | GET /players/{account_id}/peers
+*PlayersApi* | [**playersAccountIdProsGet**](Apis/PlayersApi.http#playersaccountidprosget) | **GET** /players/{account_id}/pros | GET /players/{account_id}/pros
+*PlayersApi* | [**playersAccountIdRankingsGet**](Apis/PlayersApi.http#playersaccountidrankingsget) | **GET** /players/{account_id}/rankings | GET /players/{account_id}/rankings
+*PlayersApi* | [**playersAccountIdRatingsGet**](Apis/PlayersApi.http#playersaccountidratingsget) | **GET** /players/{account_id}/ratings | GET /players/{account_id}/ratings
+*PlayersApi* | [**playersAccountIdRecentMatchesGet**](Apis/PlayersApi.http#playersaccountidrecentmatchesget) | **GET** /players/{account_id}/recentMatches | GET /players/{account_id}/recentMatches
+*PlayersApi* | [**playersAccountIdRefreshPost**](Apis/PlayersApi.http#playersaccountidrefreshpost) | **POST** /players/{account_id}/refresh | POST /players/{account_id}/refresh
+*PlayersApi* | [**playersAccountIdTotalsGet**](Apis/PlayersApi.http#playersaccountidtotalsget) | **GET** /players/{account_id}/totals | GET /players/{account_id}/totals
+*PlayersApi* | [**playersAccountIdWardmapGet**](Apis/PlayersApi.http#playersaccountidwardmapget) | **GET** /players/{account_id}/wardmap | GET /players/{account_id}/wardmap
+*PlayersApi* | [**playersAccountIdWlGet**](Apis/PlayersApi.http#playersaccountidwlget) | **GET** /players/{account_id}/wl | GET /players/{account_id}/wl
+*PlayersApi* | [**playersAccountIdWordcloudGet**](Apis/PlayersApi.http#playersaccountidwordcloudget) | **GET** /players/{account_id}/wordcloud | GET /players/{account_id}/wordcloud
+*PlayersByRankApi* | [**playersByRankGet**](Apis/PlayersByRankApi.http#playersbyrankget) | **GET** /playersByRank | GET /playersByRank
+*ProMatchesApi* | [**proMatchesGet**](Apis/ProMatchesApi.http#promatchesget) | **GET** /proMatches | GET /proMatches
+*ProPlayersApi* | [**proPlayersGet**](Apis/ProPlayersApi.http#proplayersget) | **GET** /proPlayers | GET /proPlayers
+*PublicMatchesApi* | [**publicMatchesGet**](Apis/PublicMatchesApi.http#publicmatchesget) | **GET** /publicMatches | GET /publicMatches
+*RankingsApi* | [**rankingsGet**](Apis/RankingsApi.http#rankingsget) | **GET** /rankings | GET /rankings
+*RecordsApi* | [**recordsFieldGet**](Apis/RecordsApi.http#recordsfieldget) | **GET** /records/{field} | GET /records/{field}
+*ReplaysApi* | [**replaysGet**](Apis/ReplaysApi.http#replaysget) | **GET** /replays | GET /replays
+*RequestApi* | [**requestJobIdGet**](Apis/RequestApi.http#requestjobidget) | **GET** /request/{jobId} | GET /request/{jobId}
+*RequestApi* | [**requestMatchIdPost**](Apis/RequestApi.http#requestmatchidpost) | **POST** /request/{match_id} | POST /request/{match_id}
+*ScenariosApi* | [**scenariosItemTimingsGet**](Apis/ScenariosApi.http#scenariositemtimingsget) | **GET** /scenarios/itemTimings | GET /scenarios/itemTimings
+*ScenariosApi* | [**scenariosLaneRolesGet**](Apis/ScenariosApi.http#scenarioslanerolesget) | **GET** /scenarios/laneRoles | GET /scenarios/laneRoles
+*ScenariosApi* | [**scenariosMiscGet**](Apis/ScenariosApi.http#scenariosmiscget) | **GET** /scenarios/misc | GET /scenarios/misc
+*SchemaApi* | [**schemaGet**](Apis/SchemaApi.http#schemaget) | **GET** /schema | GET /schema
+*SearchApi* | [**searchGet**](Apis/SearchApi.http#searchget) | **GET** /search | GET /search
+*StatusApi* | [**statusGet**](Apis/StatusApi.http#statusget) | **GET** /status | GET /status
+*TeamsApi* | [**teamsGet**](Apis/TeamsApi.http#teamsget) | **GET** /teams | GET /teams
+*TeamsApi* | [**teamsTeamIdGet**](Apis/TeamsApi.http#teamsteamidget) | **GET** /teams/{team_id} | GET /teams/{team_id}
+*TeamsApi* | [**teamsTeamIdHeroesGet**](Apis/TeamsApi.http#teamsteamidheroesget) | **GET** /teams/{team_id}/heroes | GET /teams/{team_id}/heroes
+*TeamsApi* | [**teamsTeamIdMatchesGet**](Apis/TeamsApi.http#teamsteamidmatchesget) | **GET** /teams/{team_id}/matches | GET /teams/{team_id}/matches
+*TeamsApi* | [**teamsTeamIdPlayersGet**](Apis/TeamsApi.http#teamsteamidplayersget) | **GET** /teams/{team_id}/players | GET /teams/{team_id}/players
+
+
+## Usage
+
+### Prerequisites
+
+You need [IntelliJ](https://www.jetbrains.com/idea/) to be able to run those queries. More information can be found [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+You may have some luck running queries using the [Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) as well, but your mileage may vary.
+
+### Variables and Environment files
+
+* Generally speaking, you want queries to be specific using custom variables. All variables in the `.http` files have the `` format.
+* You can create [public or private environment files](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#environment-variables) to dynamically replace the variables at runtime.
+
+_Note: don't commit private environment files! They typically will contain sensitive information like API Keys._
+
+### Customizations
+
+If you have control over the generation of the files here, there are two main things you can do
+
+* Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file
diff --git a/samples/client/petstore/jetbrains/http/client/Apis/PetApi.http b/samples/client/petstore/jetbrains/http/client/Apis/PetApi.http
index 10da21d8154e..b1490408c8d7 100644
--- a/samples/client/petstore/jetbrains/http/client/Apis/PetApi.http
+++ b/samples/client/petstore/jetbrains/http/client/Apis/PetApi.http
@@ -1,39 +1,71 @@
## PetApi
### Add a new pet to the store
-# @name addPet
+## Add a new pet to the store
POST http://petstore.swagger.io/v2/pet
Content-Type: application/json
Content-Type: application/xml
+Accept: application/xml
+Accept: application/json
+
+{
+ "id": "",
+ "category": "",
+ "name": "",
+ "photoUrls": "",
+ "tags": "",
+ "status": ""
+}
+
### Deletes a pet
-# @name deletePet
+## Deletes a pet
DELETE http://petstore.swagger.io/v2/pet/{{petId}}
### Finds Pets by status
-# @name findPetsByStatus
+## Finds Pets by status
GET http://petstore.swagger.io/v2/pet/findByStatus
+Accept: application/xml
+Accept: application/json
### Finds Pets by tags
-# @name findPetsByTags
+## Finds Pets by tags
GET http://petstore.swagger.io/v2/pet/findByTags
+Accept: application/xml
+Accept: application/json
### Find pet by ID
-# @name getPetById
+## Find pet by ID
GET http://petstore.swagger.io/v2/pet/{{petId}}
+Accept: application/xml
+Accept: application/json
+api_key: {{apiKey}}
### Update an existing pet
-# @name updatePet
+## Update an existing pet
PUT http://petstore.swagger.io/v2/pet
Content-Type: application/json
Content-Type: application/xml
+Accept: application/xml
+Accept: application/json
+
+{
+ "id": "",
+ "category": "",
+ "name": "",
+ "photoUrls": "",
+ "tags": "",
+ "status": ""
+}
+
### Updates a pet in the store with form data
-# @name updatePetWithForm
+## Updates a pet in the store with form data
POST http://petstore.swagger.io/v2/pet/{{petId}}
Content-Type: application/x-www-form-urlencoded
### uploads an image
-# @name uploadFile
+## uploads an image
POST http://petstore.swagger.io/v2/pet/{{petId}}/uploadImage
Content-Type: multipart/form-data
+Accept: application/json
diff --git a/samples/client/petstore/jetbrains/http/client/Apis/StoreApi.http b/samples/client/petstore/jetbrains/http/client/Apis/StoreApi.http
index 2878adaa7daa..7d258f11cd7a 100644
--- a/samples/client/petstore/jetbrains/http/client/Apis/StoreApi.http
+++ b/samples/client/petstore/jetbrains/http/client/Apis/StoreApi.http
@@ -1,18 +1,34 @@
## StoreApi
### Delete purchase order by ID
-# @name deleteOrder
+## Delete purchase order by ID
DELETE http://petstore.swagger.io/v2/store/order/{{orderId}}
### Returns pet inventories by status
-# @name getInventory
+## Returns pet inventories by status
GET http://petstore.swagger.io/v2/store/inventory
+Accept: application/json
+api_key: {{apiKey}}
### Find purchase order by ID
-# @name getOrderById
+## Find purchase order by ID
GET http://petstore.swagger.io/v2/store/order/{{orderId}}
+Accept: application/xml
+Accept: application/json
### Place an order for a pet
-# @name placeOrder
+## Place an order for a pet
POST http://petstore.swagger.io/v2/store/order
Content-Type: application/json
+Accept: application/xml
+Accept: application/json
+
+{
+ "id": "",
+ "petId": "",
+ "quantity": "",
+ "shipDate": "",
+ "status": "",
+ "complete": ""
+}
+
diff --git a/samples/client/petstore/jetbrains/http/client/Apis/UserApi.http b/samples/client/petstore/jetbrains/http/client/Apis/UserApi.http
index ab0a9e7c9138..8cef7f35ccec 100644
--- a/samples/client/petstore/jetbrains/http/client/Apis/UserApi.http
+++ b/samples/client/petstore/jetbrains/http/client/Apis/UserApi.http
@@ -1,37 +1,81 @@
## UserApi
### Create user
-# @name createUser
+## Create user
POST http://petstore.swagger.io/v2/user
Content-Type: application/json
+api_key: {{apiKey}}
+
+{
+ "id": "",
+ "username": "",
+ "firstName": "",
+ "lastName": "",
+ "email": "",
+ "password": "",
+ "phone": "",
+ "userStatus": ""
+}
+
### Creates list of users with given input array
-# @name createUsersWithArrayInput
+## Creates list of users with given input array
POST http://petstore.swagger.io/v2/user/createWithArray
Content-Type: application/json
+api_key: {{apiKey}}
+
+{
+
+}
+
### Creates list of users with given input array
-# @name createUsersWithListInput
+## Creates list of users with given input array
POST http://petstore.swagger.io/v2/user/createWithList
Content-Type: application/json
+api_key: {{apiKey}}
+
+{
+
+}
+
### Delete user
-# @name deleteUser
+## Delete user
DELETE http://petstore.swagger.io/v2/user/{{username}}
+api_key: {{apiKey}}
### Get user by user name
-# @name getUserByName
+## Get user by user name
GET http://petstore.swagger.io/v2/user/{{username}}
+Accept: application/xml
+Accept: application/json
### Logs user into the system
-# @name loginUser
+## Logs user into the system
GET http://petstore.swagger.io/v2/user/login
+Accept: application/xml
+Accept: application/json
### Logs out current logged in user session
-# @name logoutUser
+## Logs out current logged in user session
GET http://petstore.swagger.io/v2/user/logout
+api_key: {{apiKey}}
### Updated user
-# @name updateUser
+## Updated user
PUT http://petstore.swagger.io/v2/user/{{username}}
Content-Type: application/json
+api_key: {{apiKey}}
+
+{
+ "id": "",
+ "username": "",
+ "firstName": "",
+ "lastName": "",
+ "email": "",
+ "password": "",
+ "phone": "",
+ "userStatus": ""
+}
+
diff --git a/samples/client/petstore/jetbrains/http/client/README.md b/samples/client/petstore/jetbrains/http/client/README.md
index da31cb298d47..949744a7f79a 100644
--- a/samples/client/petstore/jetbrains/http/client/README.md
+++ b/samples/client/petstore/jetbrains/http/client/README.md
@@ -1,6 +1,6 @@
# OpenAPI Petstore - Jetbrains API Client
-## OpenAPI File description
+## General API description
This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
@@ -9,7 +9,8 @@ This is a sample server Petstore server. For this sample, you can use the api ke
## Documentation for API Endpoints
-All URIs are relative to *http://petstore.swagger.io/v2*, but will link to the `.http` file that contains the endpoint definition
+All URIs are relative to *http://petstore.swagger.io/v2*, but will link to the `.http` file that contains the endpoint definition.
+There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
@@ -35,5 +36,29 @@ Class | Method | HTTP request | Description
*UserApi* | [**updateUser**](Apis/UserApi.http#updateuser) | **PUT** /user/{username} | Updated user
+## Usage
-_This client was generated by the jetbrains-http-client of OpenAPI Generator_
\ No newline at end of file
+### Prerequisites
+
+You need [IntelliJ](https://www.jetbrains.com/idea/) to be able to run those queries. More information can be found [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+You may have some luck running queries using the [Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) as well, but your mileage may vary.
+
+### Variables and Environment files
+
+* Generally speaking, you want queries to be specific using custom variables. All variables in the `.http` files have the `` format.
+* You can create [public or private environment files](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#environment-variables) to dynamically replace the variables at runtime.
+
+_Note: don't commit private environment files! They typically will contain sensitive information like API Keys._
+
+### Customizations
+
+If you have control over the generation of the files here, there are two main things you can do
+
+* Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
+ * For this, run the generation with the `bodyVariables` property, followed by a "-" separated list of variables
+ * Example: `--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM`
+* Add custom headers to _all_ requests. This can be useful for example if your specifications are missing [security schemes](https://github.com/github/rest-api-description/issues/237).
+ * For this, run the generation with the `customHeaders` property, followed by a "&" separated list of variables
+ * Example : `--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"`
+
+_This client was generated by the [jetbrains-http-client](https://openapi-generator.tech/docs/generators/jetbrains-http-client) generator of OpenAPI Generator_
\ No newline at end of file